PDF
AuboStudio SDK  0.6.3
arcs::aubo_scope::PayloadModel Class Reference

API interface for payload parameters. More...

#include <payload_model.h>

Public Member Functions

 PayloadModel (PayloadModel &f)
 PayloadModel (PayloadModel &&f)
virtual ~PayloadModel ()
std::vector< PayloadPtr > getPayloads () const
 getPayloads
PayloadPtr getPayload (const std::string &name) const
 Payload
PayloadPtr getDefaultPayload () const
 Payload
PayloadPtr getCurrentPayload () const
 Payload

Private Member Functions

 PayloadModel ()

Private Attributes

void * d_ { nullptr }

Friends

class DataSwitch

Detailed Description

API interface for payload parameters.

Definition at line 18 of file payload_model.h.

Constructor & Destructor Documentation

◆ PayloadModel() [1/3]

arcs::aubo_scope::PayloadModel::PayloadModel ( PayloadModel & f)

References PayloadModel().

Referenced by PayloadModel(), and PayloadModel().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ PayloadModel() [2/3]

arcs::aubo_scope::PayloadModel::PayloadModel ( PayloadModel && f)

References PayloadModel().

Here is the call graph for this function:

◆ ~PayloadModel()

virtual arcs::aubo_scope::PayloadModel::~PayloadModel ( )
virtual

◆ PayloadModel() [3/3]

arcs::aubo_scope::PayloadModel::PayloadModel ( )
private

Member Function Documentation

◆ getCurrentPayload()

PayloadPtr arcs::aubo_scope::PayloadModel::getCurrentPayload ( ) const

Payload

getCurrentPayload

Returns

◆ getDefaultPayload()

PayloadPtr arcs::aubo_scope::PayloadModel::getDefaultPayload ( ) const

Payload

getDefaultPayload

Returns

◆ getPayload()

PayloadPtr arcs::aubo_scope::PayloadModel::getPayload ( const std::string & name) const

Payload

getPayload

Parameters
name
Returns

◆ getPayloads()

std::vector< PayloadPtr > arcs::aubo_scope::PayloadModel::getPayloads ( ) const

getPayloads

Returns
A collection of all the payloads from the current installation in AuboScope, including user-defined payloads and payloads added by aubo_studio plugins.

◆ DataSwitch

friend class DataSwitch
friend

Definition at line 60 of file payload_model.h.

References DataSwitch.

Referenced by DataSwitch.

Member Data Documentation

◆ d_

void* arcs::aubo_scope::PayloadModel::d_ { nullptr }
private

Definition at line 62 of file payload_model.h.


The documentation for this class was generated from the following file: