AuboCaps  0.6.0
arcs::aubo_scope::ApplicationApi Class Reference

Provides access to functionality and services which are relevant for various different applications and contexts. More...

#include <application_api.h>

Inheritance diagram for arcs::aubo_scope::ApplicationApi:

Public Member Functions

 ApplicationApi (ApplicationApi &f)
 
 ApplicationApi (ApplicationApi &&f)
 
virtual ~ApplicationApi ()
 
IoModelPtr getIoModel ()
 
FeatureModelPtr getFeatureModel ()
 
TcpModelPtr getTcpModel ()
 
PayloadModelPtr getPayloadModel ()
 Gets an interface which provides access the payloads in the current AuboScope installation. More...
 
VariableModelPtr getVariableModel ()
 
ValueFactoryPtr getValueFactory ()
 
template<typename T >
std::shared_ptr< T > getInstallationNode ()
 This method can be used to get a specific InstallationNodeContribution instance. More...
 
InstallationNodeContributionPtr getInstallationNode (const char *typeidOfClass)
 
DeviceManagerPtr getDeviceManager ()
 This method can be used to get a specific DeviceManager instance. More...
 
aubo_sdk::RobotProxyPtr getRobotProxy ()
 getRobotProxy More...
 

Protected Member Functions

 ApplicationApi ()
 

Private Attributes

void * d_ { nullptr }
 

Friends

class DataSwitch
 

Detailed Description

Provides access to functionality and services which are relevant for various different applications and contexts.

This includes what is available from within AuboScope, as well as creating additional model elements to be used within AuboScope.

Definition at line 28 of file application_api.h.

Constructor & Destructor Documentation

arcs::aubo_scope::ApplicationApi::ApplicationApi ( ApplicationApi f)
arcs::aubo_scope::ApplicationApi::ApplicationApi ( ApplicationApi &&  f)
virtual arcs::aubo_scope::ApplicationApi::~ApplicationApi ( )
virtual
arcs::aubo_scope::ApplicationApi::ApplicationApi ( )
protected

Member Function Documentation

DeviceManagerPtr arcs::aubo_scope::ApplicationApi::getDeviceManager ( )

This method can be used to get a specific DeviceManager instance.

Parameters
deviceManagerClassThe class for the device manager to return
<T>The generic type of class to return
Returns
An interface for registering and working with a specific device
FeatureModelPtr arcs::aubo_scope::ApplicationApi::getFeatureModel ( )
Returns
An interface for working with the features of the current installation
template<typename T >
std::shared_ptr<T> arcs::aubo_scope::ApplicationApi::getInstallationNode ( )
inline

This method can be used to get a specific InstallationNodeContribution instance.

Returns
An interface with access to various queryable-only system resources
Parameters
installationTypeThe class of the installation node contribution to return
<T>The generic for specifying the InstallationNodeContribution
Returns
The installation node instance

Definition at line 89 of file application_api.h.

InstallationNodeContributionPtr arcs::aubo_scope::ApplicationApi::getInstallationNode ( const char *  typeidOfClass)
IoModelPtr arcs::aubo_scope::ApplicationApi::getIoModel ( )
Returns
An interface for working with the inputs and outputs of the robot
PayloadModelPtr arcs::aubo_scope::ApplicationApi::getPayloadModel ( )

Gets an interface which provides access the payloads in the current AuboScope installation.

Returns
An interface for accessing the payloads in the current AuboScope installation
aubo_sdk::RobotProxyPtr arcs::aubo_scope::ApplicationApi::getRobotProxy ( )

getRobotProxy

Returns
TcpModelPtr arcs::aubo_scope::ApplicationApi::getTcpModel ( )
Returns
An interface for accessing the TCPs of the current installation
ValueFactoryPtr arcs::aubo_scope::ApplicationApi::getValueFactory ( )
Returns
An interface for accessing various factories capable of creating value objects.
VariableModelPtr arcs::aubo_scope::ApplicationApi::getVariableModel ( )
Returns
An interface for working with variables

Friends And Related Function Documentation

friend class DataSwitch
friend

Definition at line 118 of file application_api.h.

Member Data Documentation

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

Definition at line 119 of file application_api.h.


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