PlatformUnitPropertyDefinitions Class Reference
Defines all necessary properties for armarx::PlatformUnit. More...
#include <RobotAPI/components/units/PlatformUnit.h>
Inheritance diagram for PlatformUnitPropertyDefinitions:Public Member Functions | |
| PlatformUnitPropertyDefinitions (std::string prefix) | |
| Public Member Functions inherited from ComponentPropertyDefinitions | |
| ComponentPropertyDefinitions (std::string prefix, bool hasObjectNameParameter=true) | |
| Public Member Functions inherited from PropertyDefinitionContainer | |
| template<typename PropertyType > | |
| void | component (IceInternal::ProxyHandle< PropertyType > &setter, const std::string &default_name="", const std::string &property_name="", const std::string &description="") |
| template<typename PropertyType > | |
| PropertyDefinition< PropertyType > & | defineOptionalProperty (const std::string &name, PropertyType defaultValue, const std::string &description="", PropertyDefinitionBase::PropertyConstness constness=PropertyDefinitionBase::eConstant) |
| template<typename EigenVectorType > | |
| PropertyDefinition< EigenVectorType > & | defineOptionalPropertyVector (const std::string &name, EigenVectorType defaultValue, const std::string &description, char delimiter) |
| template<typename EigenVectorType > | |
| PropertyDefinition< EigenVectorType > & | defineOptionalPropertyVector (const std::string &name, EigenVectorType defaultValue, const std::string &description, char delimiter, PropertyDefinitionBase::PropertyConstness constness) |
| template<typename EigenVectorType > | |
| PropertyDefinition< EigenVectorType > & | defineOptionalPropertyVector (const std::string &name, EigenVectorType defaultValue, const std::string &description="", const std::string &delimiter=" ", PropertyDefinitionBase::PropertyConstness constness=PropertyDefinitionBase::eConstant) |
| Define a required property for an Eigen vector type. More... | |
| template<typename PropertyType > | |
| PropertyDefinition< PropertyType > & | defineRequiredProperty (const std::string &name, const std::string &description="", PropertyDefinitionBase::PropertyConstness constness=PropertyDefinitionBase::eConstant) |
| template<typename EigenVectorType > | |
| PropertyDefinition< EigenVectorType > & | defineRequiredPropertyVector (const std::string &name, const std::string &description, char delimiter) |
| template<typename EigenVectorType > | |
| PropertyDefinition< EigenVectorType > & | defineRequiredPropertyVector (const std::string &name, const std::string &description, char delimiter, PropertyDefinitionBase::PropertyConstness constness) |
| template<typename EigenVectorType > | |
| PropertyDefinition< EigenVectorType > & | defineRequiredPropertyVector (const std::string &name, const std::string &description="", const std::string &delimiter=" ", PropertyDefinitionBase::PropertyConstness constness=PropertyDefinitionBase::eConstant) |
| Define a required property for an Eigen vector type. More... | |
| PropertyDefinitionBase * | getDefinitionBase (const std::string &name) |
| template<typename PropertyType > | |
| PropertyDefinition< PropertyType > & | getDefintion (const std::string &name) |
| std::string | getDescription () const |
| Returns the detailed description of the property user. More... | |
| std::string | getPrefix () |
| Ice::PropertiesPtr | getProperties () |
| std::map< std::string, std::string > | getPropertyValues (const std::string &prefix="") const |
| std::map< std::string, ProxyPropertyDefinitionBase * > | getProxyDefinitions () |
| std::vector< std::string > | getSubscribedTopicDefinitions () |
| std::string | getValue (const std::string &name) |
| bool | hasDefinition (const std::string &name) const |
| bool | isPropertySet (const std::string &name) |
| template<typename PropertyType > | |
| decltype(auto) | optional (PropertyType &setter, const std::string &name, const std::string &description="", PropertyDefinitionBase::PropertyConstness constness=PropertyDefinitionBase::eConstant) |
| PropertyDefinitionContainer (const std::string &prefix) | |
| template<typename PropertyType > | |
| decltype(auto) | required (PropertyType &setter, const std::string &name, const std::string &description="", PropertyDefinitionBase::PropertyConstness constness=PropertyDefinitionBase::eConstant) |
| template<typename PropertyType > | |
| decltype(auto) | requiredOrOptional (bool isRequired, PropertyType &setter, const std::string &name, const std::string &description="", PropertyDefinitionBase::PropertyConstness constness=PropertyDefinitionBase::eConstant) |
| void | setDescription (const std::string &description) |
| Sets the detailed description of the property user. More... | |
| void | setPrefix (std::string prefix) |
| void | setProperties (Ice::PropertiesPtr properties) |
| template<typename PropertyType > | |
| void | topic (IceInternal::ProxyHandle< PropertyType > &setter, const std::string &default_name="", const std::string &property_name="", const std::string &description="") |
| Define a property to set the name of a topic which is subscribed to. More... | |
| template<typename PropertyType > | |
| void | topic (std::string default_name="", std::string property_name="", std::string description="") |
| Define a topic which is offered from the component via the template parameter. More... | |
| std::string | toString (PropertyDefinitionFormatter &formatter) |
| void | writeProxyValues (IceManagerPtr) |
| void | writeValues () |
| ~PropertyDefinitionContainer () override | |
Additional Inherited Members | |
| Public Types inherited from PropertyDefinitionContainer | |
| typedef std::map< std::string, PropertyDefinitionBase * > | DefinitionContainer |
| Static Public Member Functions inherited from PropertyDefinitionContainer | |
| template<typename EigenVectorType > | |
| static EigenVectorType | eigenVectorFactoryFunction (std::string string, std::string delim) |
Parses string to an Eigen vector of type EigenVectorType. More... | |
| static std::string | eigenVectorPropertyDescription (const std::string &description, long size, std::string delim) |
| template<typename EigenVectorType > | |
| static std::string | eigenVectorToString (const EigenVectorType &vector, std::string delim) |
| Protected Attributes inherited from PropertyDefinitionContainer | |
| std::string | briefDescription |
| PropertyUser brief description. More... | |
| DefinitionContainer | definitions |
| Property definitions container. More... | |
| std::string | description |
| Property User description. More... | |
| std::string | prefix |
| Prefix of the properties such as namespace, domain, component name, etc. More... | |
| Ice::PropertiesPtr | properties |
| std::map< std::string, ProxyPropertyDefinitionBase * > | proxies |
| std::vector< std::string > | subscribedTopics |
Detailed Description
Defines all necessary properties for armarx::PlatformUnit.
Definition at line 43 of file PlatformUnit.h.
Constructor & Destructor Documentation
◆ PlatformUnitPropertyDefinitions()
|
inline |
Definition at line 46 of file PlatformUnit.h.
The documentation for this class was generated from the following file:
- RobotAPI/components/units/PlatformUnit.h
