List of all members | Public Member Functions
RobotUnitComponentPlugin Class Reference

#include <RobotAPI/libraries/RobotAPIComponentPlugins/RobotUnitComponentPlugin.h>

+ Inheritance diagram for RobotUnitComponentPlugin:

Public Member Functions

template<class PrxT >
PrxT createNJointController (const std::string &className, const std::string &instanceName, const NJointControllerConfigPtr &config, bool doManageController=true)
 
NJointControllerInterfacePrx createNJointController (const std::string &className, const std::string &instanceName, const NJointControllerConfigPtr &config, bool doManageController=true)
 
template<class PrxT >
void createNJointController (PrxT &prx, const std::string &className, const std::string &instanceName, const NJointControllerConfigPtr &config, bool doManageController=true)
 
RobotUnitInterfacePrx getRobotUnit () const
 
const std::string & getRobotUnitName () const
 
bool hasRobotUnitName () const
 
void manageController (const NJointControllerInterfacePrx &ctrl)
 
void manageController (const std::string &ctrl)
 
void postCreatePropertyDefinitions (PropertyDefinitionsPtr &properties) override
 
void postOnDisconnectComponent () override
 
void preOnConnectComponent () override
 
void preOnInitComponent () override
 
bool robotUnitIsRunning () const
 
void setRobotUnitAsOptionalDependency (bool isOptional=true)
 
void setRobotUnitName (const std::string &name)
 
RobotUnitDataStreamingReceiverPtr startDataStreaming (const RobotUnitDataStreaming::Config &cfg)
 
void waitUntilRobotUnitIsRunning (const std::function< bool()> &termCond=[] { return false;})
 Waits until the robot unit is running. More...
 
- Public Member Functions inherited from ManagedIceObjectPlugin
ManagedIceObject & parent ()
 
template<class T >
T & parent ()
 
const ManagedIceObject & parent () const
 
template<class T >
const T & parent () const
 
template<class T >
bool parentDerives () const
 
virtual ~ManagedIceObjectPlugin ()=default
 

Additional Inherited Members

- Protected Member Functions inherited from ComponentPlugin
virtual void componentPropertiesUpdated (const std::set< std::string > &changedProperties)
 
 ManagedIceObjectPlugin (ManagedIceObject &parent, std::string pre)
 
- Protected Member Functions inherited from ManagedIceObjectPlugin
template<class PluginT , class... ParamsT>
PluginT * addPlugin (const std::string prefix="", ParamsT &&...params)
 
template<class PluginT , class... ParamsT>
void addPlugin (PluginT *&targ, const std::string prefix="", ParamsT &&...params)
 
template<class PluginT , class... ParamsT>
void addPlugin (std::experimental::observer_ptr< PluginT > &targ, const std::string prefix="", ParamsT &&...params)
 
void addPluginDependency (ManagedIceObjectPlugin *dependedOn)
 
void addPluginDependency (std::experimental::observer_ptr< ManagedIceObjectPlugin > dependedOn)
 
std::string makePropertyName (const std::string &name)
 
 ManagedIceObjectPlugin (ManagedIceObject &parent, std::string pre)
 
virtual void postOnConnectComponent ()
 
virtual void postOnExitComponent ()
 
virtual void postOnInitComponent ()
 
const std::string & prefix () const
 
virtual void preOnDisconnectComponent ()
 
virtual void preOnExitComponent ()
 

Detailed Description

Definition at line 11 of file RobotUnitComponentPlugin.h.

Member Function Documentation

◆ createNJointController() [1/3]

PrxT createNJointController ( const std::string &  className,
const std::string &  instanceName,
const NJointControllerConfigPtr &  config,
bool  doManageController = true 
)
inline

Definition at line 49 of file RobotUnitComponentPlugin.h.

+ Here is the caller graph for this function:

◆ createNJointController() [2/3]

NJointControllerInterfacePrx createNJointController ( const std::string &  className,
const std::string &  instanceName,
const NJointControllerConfigPtr &  config,
bool  doManageController = true 
)

◆ createNJointController() [3/3]

void createNJointController ( PrxT &  prx,
const std::string &  className,
const std::string &  instanceName,
const NJointControllerConfigPtr &  config,
bool  doManageController = true 
)
inline

Definition at line 60 of file RobotUnitComponentPlugin.h.

+ Here is the call graph for this function:

◆ getRobotUnit()

RobotUnitInterfacePrx getRobotUnit ( ) const

Definition at line 112 of file RobotUnitComponentPlugin.cpp.

+ Here is the caller graph for this function:

◆ getRobotUnitName()

const std::string & getRobotUnitName ( ) const

Definition at line 125 of file RobotUnitComponentPlugin.cpp.

◆ hasRobotUnitName()

bool hasRobotUnitName ( ) const

Definition at line 131 of file RobotUnitComponentPlugin.cpp.

+ Here is the caller graph for this function:

◆ manageController() [1/2]

void manageController ( const NJointControllerInterfacePrx &  ctrl)

◆ manageController() [2/2]

void manageController ( const std::string &  ctrl)

Definition at line 64 of file RobotUnitComponentPlugin.cpp.

◆ postCreatePropertyDefinitions()

void postCreatePropertyDefinitions ( armarx::PropertyDefinitionsPtr &  properties)
overridevirtual

Reimplemented from ComponentPlugin.

Definition at line 93 of file RobotUnitComponentPlugin.cpp.

+ Here is the caller graph for this function:

◆ postOnDisconnectComponent()

void postOnDisconnectComponent ( )
overridevirtual

Reimplemented from ManagedIceObjectPlugin.

Definition at line 18 of file RobotUnitComponentPlugin.cpp.

◆ preOnConnectComponent()

void preOnConnectComponent ( )
overridevirtual

Reimplemented from ManagedIceObjectPlugin.

Definition at line 84 of file RobotUnitComponentPlugin.cpp.

+ Here is the caller graph for this function:

◆ preOnInitComponent()

void preOnInitComponent ( )
overridevirtual

Reimplemented from ManagedIceObjectPlugin.

Definition at line 70 of file RobotUnitComponentPlugin.cpp.

+ Here is the caller graph for this function:

◆ robotUnitIsRunning()

bool robotUnitIsRunning ( ) const

Definition at line 164 of file RobotUnitComponentPlugin.cpp.

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

◆ setRobotUnitAsOptionalDependency()

void setRobotUnitAsOptionalDependency ( bool  isOptional = true)

Definition at line 137 of file RobotUnitComponentPlugin.cpp.

+ Here is the caller graph for this function:

◆ setRobotUnitName()

void setRobotUnitName ( const std::string &  name)

Definition at line 118 of file RobotUnitComponentPlugin.cpp.

+ Here is the caller graph for this function:

◆ startDataStreaming()

RobotUnitDataStreamingReceiverPtr startDataStreaming ( const RobotUnitDataStreaming::Config &  cfg)

Definition at line 11 of file RobotUnitComponentPlugin.cpp.

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

◆ waitUntilRobotUnitIsRunning()

void waitUntilRobotUnitIsRunning ( const std::function< bool()> &  termCond = [] { return false; })

Waits until the robot unit is running.

Although the robot unit proxy might be initialized (

See also
getRobotUnit()), the robot unit might not be fully initialized.
Parameters
termCondTermination condition. If it evaluates to true, waitUntilRobotUnitIsRunning returns without waiting for the robot unit to become available.

Definition at line 143 of file RobotUnitComponentPlugin.cpp.

+ Here is the call graph for this function:
The documentation for this class was generated from the following files: