ComponentPropertyDefinitions Class Reference

Default component property definition container. More...

#include <ArmarXCore/core/Component.h>

Inherits PropertyDefinitionContainer.

Inherited by AffordanceExtractionPropertyDefinitions, AffordancePipelineVisualizationPropertyDefinitions, AffordanceUpdateListenerPropertyDefinitions, ArmarXFileLoggerPropertyDefinitions, ArmarXPhysicsWorldVisualizationPropertyDefinitions, ArmarXSimulatorWindowPropertyDefinitions, ArmarXTimeserverPropertyDefinitions, AronComponentConfigExamplePropertyDefinitions, AStarPathPlannerTestComponentPropertyDefinitions, ATINetFTUnitPropertyDefinitions, CollisionCheckerComponentPropertyDefinitions, ConditionHandlerPropertyDefinitions, DebugDrawerPropertyDefinitions, DebugDrawerToArVizPropertyDefinitions, DHParameterOptimizationLoggerPropertyDefinitions, DMPComponentPropertyDefinitions, DummyAgentReporterPropertyDefinitions, DummyObjectLocalizerPropertyDefinitions, DummyTextToSpeechPropertyDefinitions, DummyWorldStateObserverPropertyDefinitions, EmergencyStopNodePropertyDefinitions, EmergencyStopPropertyMasterDefinitions, ExternalApplicationManagerPropertyDefinitions, FakeWorkingMemoryObjectLocalizerPropertyDefinitions, FlyCaptureImageProviderPropertyDefinitions, ForceTorqueUnitPropertyDefinitions, FrameTrackingPropertyDefinitions, FunctionApproximatorPropertyDefinitions, GamepadControlUnitPropertyDefinitions, GamepadUnitPropertyDefinitions, GraspingManagerPropertyDefinitions, GraspingManagerTestPropertyDefinitions, GraspProviderExamplePropertyDefinitions, GraspSelectionCriterionPropertyDefinitions, GraspSelectionManagerPropertyDefinitions, HandUnitPropertyDefinitions, HapticUnitPropertyDefinitions, HeadIKUnitPropertyDefinitions, HokuyoLaserUnitPropertyDefinitions, ImageSequenceProviderDynamicSimulationPropertyDefinitions, InertialMeasurementUnitPropertyDefinitions, JsonStoragePropertyDefinitions, KBMComponentPropertyDefinitions, KinematicSelfLocalizationPropertyDefinitions, KinematicUnitPropertyDefinitions, KITProstheticHandObserverPropertyDefinitions, LaserScannerSimulationPropertyDefinitions, LaserScannerSelfLocalisationPropertyDefinitions, MetaWearIMUPropertyDefinitions, MMMPlayerPropertyDefinitions, MMMSimulationPropertyDefinitions, MotionPlanningServerPropertyDefinitions, MultiHandUnitPropertyDefinitions, NaturalIKTestPropertyDefinitions, ObjectLocalizationSaliencyPropertyDefinitions, ObjectLocalizerDynamicSimulationPropertyDefinitions, ObserverPropertyDefinitions, OpenPoseSimulationPropertyDefinitions, OptoForcePropertyDefinitions, OptoForceUnitPropertyDefinitions, OrientedTactileSensorUnitPropertyDefinitions, PathPlannerPropertyDefinitions, PingLoadTestPropertyDefinitions, PlannedMotionProviderPropertyDefinitions, PlatformUnitPropertyDefinitions, PointCloudUtilityPropertyDefinitions, PrimitiveExtractionParameterTuningPropertyDefinitions, PrimitiveExtractorPropertyDefinitions, PrimitiveVisualizationPropertyDefinitions, RCImageProviderPropertyDefinitions, ReflexCombinationPropertyDefinitions, RemoteGuiProviderPropertyDefinitions, RemoteObjectNodePropertyDefinitions, RobotHandLocalizationDynamicSimulationPropertyDefinitions, RobotHealthDummyPropertyDefinitions, RobotIKPropertyDefinitions, RobotPoseUnitPropertyDefinitions, RobotStatePropertyDefinitions, RobotToArVizPropertyDefinitions, ModuleBaseIntermediatePropertyDefinitions, SceneModifierPropertyDefinitions, ShapesSupportRelationsPropertyDefinitions, SemanticGraphExamplePropertyDefinitions, SemanticGraphStoragePropertyDefinitions, SemanticRelationAnalyzerPropertyDefinitions, SimpleGraspGeneratorPropertyDefinitions, SimpleRobotPlacementPropertyDefinitions, SimpleStatechartExecutorPropertyDefinitions, SimulatorPropertyDefinitions, StatechartContextPropertyDefinitions, StatechartExecutorExamplePropertyDefinitions, StaticAgentReporterPropertyDefinitions, StreamDecoderImageProviderPropertyDefinitions, StreamReceiver::StreamReceiverPropertyDefinitions, TCPControllerSubUnitPropertyDefinitions, TCPControlUnitPropertyDefinitions, TopicRecorderProperties, TopicReplayerProperties, TopicTimingClientPropertyDefinitions, TopicTimingServerPropertyDefinitions, TrajectoryControllerSubUnitPropertyDefinitions, TrajectoryPlayerPropertyDefinitions, ValveAttentionPropertyDefinitions, ViconMarkerProviderPropertyDefinitions, ViewSelectionPropertyDefinitions, WorkingMemoryToArVizPropertyDefinitions, XMLStateComponentProperties, AbstractLongtermMemoryPropertyDefinitions, AbstractWorkingMemoryPropertyDefinitions, CommonPlacesLearnerPropertyDefinitions, CommonPlacesTesterPropertyDefinitions, CommonStoragePropertyDefinitions, GraphNodePoseResolverPropertyDefinitions, PriorKnowledgeImporterPropertyDefinitions, PriorKnowledgePropertyDefinitions, ProfilerStoragePropertyDefinitions, SimoxSceneImporterPropertyDefinitions, WorkingMemoryExamplePropertyDefinitions, WorkingMemoryUpdaterProperties, WorldStateObserverPropertyDefinitions, WorldStateUpdaterPropertyDefinitions, XMLSceneImporterPropertyDefinitions, CapturingImageProviderPropertyDefinitions, DeepFaceRecognitionPropertyDefinitions, DummyArMarkerLocalizerPropertyDefinitions, IEEE1394PropertyDefinitions, ImageProcessorPropertyDefinitions, ImageSequenceProviderPropertyDefinitions, ObjectLearningByPushingPropertyDefinitions, ObjectShapeClassificationPropertyDefinitions, OLPEvaluationPropertyDefinitions, OpenNIPropertyDefinitions, PointCloudObjectLocalizerPropertyDefinitions, PointCloudProcessorPropertyDefinitions, PointCloudProviderPropertyDefinitions, PointCloudVisualizationPropertyDefinitions, RCPointCloudProviderPropertyDefinitions, RGBDHandLocalizerPropertyDefinitions, UCLObjectRecognitionPropertyDefinitions, VideoFileImageProviderPropertyDefinitions, VoxelGridMappingProviderPropertyDefinitions, and WebCamImageProviderPropertyDefinitions.

Public Member Functions
	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

Default component property definition container.

See also

properties

Inherit from this class to extend your property definitions for components!

Definition at line 70 of file Component.h.

Constructor & Destructor Documentation

ComponentPropertyDefinitions()

ComponentPropertyDefinitions	(	std::string	prefix,
		bool	hasObjectNameParameter = true
	)

Definition at line 37 of file Component.cpp.

---

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

• ArmarXCore/core/Component.h
• ArmarXCore/core/Component.cpp