List of all members | Classes | Public Types | Public Member Functions
ControlTargetBase Class Referenceabstract
RobotAPI » RobotUnit

Brief description of class JointControlTargetBase. More...

#include <RobotAPI/components/units/RobotUnit/ControlTargets/ControlTargetBase.h>

+ Inheritance diagram for ControlTargetBase:

Classes

class  ControlDeviceAccessToken
 

Public Types

template<class DerivedClass >
using ControlTargetInfo = introspection::ClassMemberInfo< ControlTargetBase, DerivedClass >
 

Public Member Functions

template<class T , class = typename std::enable_if<std::is_base_of<ControlTargetBase, T>::value>::type>
void _copyTo (std::unique_ptr< T > &target) const
 
 ARMARX_META_MAKE_HAS_MEMBER_FNC_CHECK (ControlTargetHasGetClassMemberInfo, GetClassMemberInfo, ControlTargetInfo< T >(*)(void))
 
template<class T >
T * asA ()
 
template<class T >
const T * asA () const
 
virtual const std::string & getControlMode () const =0
 
virtual std::string getControlTargetType (bool withoutNamespaceSpecifier=false) const =0
 
virtual void getDataFieldAs (std::size_t i, bool &out) const =0
 
virtual void getDataFieldAs (std::size_t i, Ice::Byte &out) const =0
 
virtual void getDataFieldAs (std::size_t i, Ice::Double &out) const =0
 
virtual void getDataFieldAs (std::size_t i, Ice::Float &out) const =0
 
virtual void getDataFieldAs (std::size_t i, Ice::Int &out) const =0
 
virtual void getDataFieldAs (std::size_t i, Ice::Long &out) const =0
 
virtual void getDataFieldAs (std::size_t i, Ice::Short &out) const =0
 
virtual void getDataFieldAs (std::size_t i, std::string &out) const =0
 
virtual std::vector< std::string > getDataFieldNames () const =0
 
virtual const std::type_info & getDataFieldType (std::size_t i) const =0
 
virtual std::size_t getNumberOfDataFields () const =0
 
template<class T >
bool isA () const
 
virtual bool isValid () const =0
 
virtual void reset ()=0
 
virtual std::map< std::string, VariantBasePtr > toVariants (const IceUtil::Time &timestamp) const =0
 used to send the data to the DebugObserverTopic and to other Components (e.g. GUI widgets) More...
 
virtual ~ControlTargetBase ()=default
 

Detailed Description

Brief description of class JointControlTargetBase.

Detailed description of class ControlTargetBase.

Definition at line 47 of file ControlTargetBase.h.

Member Typedef Documentation

◆ ControlTargetInfo

using ControlTargetInfo = introspection::ClassMemberInfo<ControlTargetBase, DerivedClass>

Definition at line 58 of file ControlTargetBase.h.

Constructor & Destructor Documentation

◆ ~ControlTargetBase()

virtual ~ControlTargetBase ( )
virtualdefault

Member Function Documentation

◆ _copyTo()

void _copyTo ( std::unique_ptr< T > &  target) const
inline

Definition at line 110 of file ControlTargetBase.h.

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

◆ ARMARX_META_MAKE_HAS_MEMBER_FNC_CHECK()

ARMARX_META_MAKE_HAS_MEMBER_FNC_CHECK ( ControlTargetHasGetClassMemberInfo  ,
GetClassMemberInfo  ,
ControlTargetInfo< T >  *)(void 
)

◆ asA() [1/2]

T* asA ( )
inline

Definition at line 83 of file ControlTargetBase.h.

◆ asA() [2/2]

const T* asA ( ) const
inline

Definition at line 76 of file ControlTargetBase.h.

◆ getControlMode()

virtual const std::string& getControlMode ( ) const
pure virtual

Implemented in ControlTarget1DoFActuatorPWM, ActiveImpedanceControlTarget, and ControlTargetHolonomicPlatformVelocity.

+ Here is the caller graph for this function:

◆ getControlTargetType()

virtual std::string getControlTargetType ( bool  withoutNamespaceSpecifier = false) const
pure virtual

◆ getDataFieldAs() [1/8]

virtual void getDataFieldAs ( std::size_t  i,
bool &  out 
) const
pure virtual

◆ getDataFieldAs() [2/8]

virtual void getDataFieldAs ( std::size_t  i,
Ice::Byte &  out 
) const
pure virtual

◆ getDataFieldAs() [3/8]

virtual void getDataFieldAs ( std::size_t  i,
Ice::Double &  out 
) const
pure virtual

◆ getDataFieldAs() [4/8]

virtual void getDataFieldAs ( std::size_t  i,
Ice::Float &  out 
) const
pure virtual

◆ getDataFieldAs() [5/8]

virtual void getDataFieldAs ( std::size_t  i,
Ice::Int &  out 
) const
pure virtual

◆ getDataFieldAs() [6/8]

virtual void getDataFieldAs ( std::size_t  i,
Ice::Long &  out 
) const
pure virtual

◆ getDataFieldAs() [7/8]

virtual void getDataFieldAs ( std::size_t  i,
Ice::Short &  out 
) const
pure virtual

◆ getDataFieldAs() [8/8]

virtual void getDataFieldAs ( std::size_t  i,
std::string &  out 
) const
pure virtual

◆ getDataFieldNames()

virtual std::vector<std::string> getDataFieldNames ( ) const
pure virtual

◆ getDataFieldType()

virtual const std::type_info& getDataFieldType ( std::size_t  i) const
pure virtual

◆ getNumberOfDataFields()

virtual std::size_t getNumberOfDataFields ( ) const
pure virtual

◆ isA()

bool isA ( ) const
inline

Definition at line 69 of file ControlTargetBase.h.

+ Here is the caller graph for this function:

◆ isValid()

virtual bool isValid ( ) const
pure virtual

Implemented in ControlTarget1DoFActuatorPWM, ActiveImpedanceControlTarget, and ControlTargetHolonomicPlatformVelocity.

+ Here is the caller graph for this function:

◆ reset()

virtual void reset ( )
pure virtual

Implemented in ControlTarget1DoFActuatorPWM, ActiveImpedanceControlTarget, and ControlTargetHolonomicPlatformVelocity.

+ Here is the caller graph for this function:

◆ toVariants()

virtual std::map<std::string, VariantBasePtr> toVariants ( const IceUtil::Time &  timestamp) const
pure virtual

used to send the data to the DebugObserverTopic and to other Components (e.g. GUI widgets)

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