Baseclass for all ArmarX ManagedIceObjects requiring properties. More...

#include <ArmarXCore/core/Component.h>

Inherits ManagedIceObject, and PropertyUser.

Public Member Functions
virtual void	componentPropertiesUpdated (const std::set< std::string > &changedProperties)
	Implement this function if you would like to react to changes in the properties. More...

void	forceComponentCreatedByComponentCreateFunc ()
	forces the flag to be set to true that the object instance was created by the Component::create function More...

std::vector< PropertyUserPtr >	getAdditionalPropertyUsers () const

template<typename PropertyType >
Property< PropertyType >	getProperty (const std::string &name)

template<typename PropertyType >
Property< PropertyType >	getProperty (const std::string &name) const

template<class T >
void	getProperty (std::atomic< T > &val, const std::string &name) const

template<class T >
void	getProperty (T &val, const std::string &name) const

template<class ProxyType >
ProxyType	getProxyFromProperty (const std::string &propertyName, bool addToDependencies=false, const std::string &endpoints="", bool throwOnProxyError=true)
	Get a proxy whose name is specified by the given property. More...

template<class ProxyType >
void	getProxyFromProperty (ProxyType &proxy, const std::string &propertyName, bool addToDependencies=false, const std::string &endpoints="", bool throwOnProxyError=true)

template<class TopicProxyType >
TopicProxyType	getTopicFromProperty (const std::string &propertyName)
	Get a topic proxy whose name is specified by the given property. More...

template<class TopicProxyType >
void	getTopicFromProperty (TopicProxyType &top, const std::string &propertyName)

void	initializeProperties (const std::string &configName, Ice::PropertiesPtr const &properties, const std::string &configDomain)
	initializes the properties of this component. More...

void	injectPropertyDefinitions (PropertyDefinitionsPtr &props) override

void	offeringTopicFromProperty (const std::string &propertyName)
	Offer a topic whose name is specified by the given property. More...

virtual void	preOnConnectComponent () override

virtual void	preOnInitComponent () override

bool	usingProxyFromProperty (const std::string &propertyName, const std::string &endpoints="")
	Use a proxy whose name is specified by the given property. More...

void	usingTopicFromProperty (const std::string &propertyName, bool orderedPublishing=false)
	Use a topic whose name is specified by the given property. More...

Public Member Functions inherited from ManagedIceObject
void	enableProfiler (bool enable)
	setProfiler allows setting ManagedIceObject::profiler to a new instance (if the new instance is actually not a null pointer) More...

std::string	generateSubObjectName (const std::string &subObjectName)
	Generates a unique name for a sub object from a general name. More...

ArmarXManagerPtr	getArmarXManager () const
	Returns the ArmarX manager used to add and remove components. More...

ManagedIceObjectConnectivity	getConnectivity () const
	Retrieve connectivity of the object (topcis as well as proxies) More...

virtual std::string	getDefaultName () const =0
	Retrieve default name of component. More...

IceManagerPtr	getIceManager () const
	Returns the IceManager. More...

VariantBasePtr	getMetaInfo (const std::string &id)

StringVariantBaseMap	getMetaInfoMap () const

std::string	getName () const
	Retrieve name of object. More...

Ice::ObjectAdapterPtr	getObjectAdapter () const
	Returns object's Ice adapter. More...

ArmarXObjectSchedulerPtr	getObjectScheduler () const

PeriodicTaskPtr	getPeriodicTask (const std::string &name)

Profiler::ProfilerPtr	getProfiler () const
	getProfiler returns an instance of armarx::Profiler More...

template<class ProxyTarg , class... Args>
void	getProxy (const char *name, IceInternal::ProxyHandle< ProxyTarg > &proxy, Args &&...args)

template<class ProxyType >
ProxyType	getProxy (const std::string &name, bool addToDependencies=false, const std::string &endpoints="", bool throwOnProxyError=true)
	Retrieves a proxy object. More...

template<class ProxyTarg , class... Args>
void	getProxy (const std::string &name, IceInternal::ProxyHandle< ProxyTarg > &proxy, Args &&...args)

template<class ProxyTarg , class... Args>
void	getProxy (IceInternal::ProxyHandle< ProxyTarg > &proxy, const char *name, Args &&...args)

template<class ProxyTarg , class... Args>
void	getProxy (IceInternal::ProxyHandle< ProxyTarg > &proxy, const std::string &name, Args &&...args)
	Assigns a proxy to `proxy`. More...

Ice::ObjectPrx	getProxy (long timeoutMs=0, bool waitForScheduler=true) const
	Returns the proxy of this object (optionally it waits for the proxy) More...

template<class Prx >
Prx	getProxy (long timeoutMs=0, bool waitForScheduler=true) const

template<class ProxyType >
void	getProxy (ProxyType &proxy, const char *name, bool addToDependencies=false, const std::string &endpoints="", bool throwOnProxyError=true)
	Overload to allow using string literals as name (solve ambiguous overload). More...

template<class Prx >
void	getProxy (Prx &prx, long timeoutMs=0, bool waitForScheduler=true) const

int	getState () const
	Retrieve current state of the ManagedIceObject. More...

template<class TopicProxyType >
TopicProxyType	getTopic (const std::string &name)
	Returns a proxy of the specified topic. More...

template<class TopicProxyType >
void	getTopic (TopicProxyType &topicProxy, const std::string &name)
	Assigns a proxy of the specified topic to `topicProxy`. More...

std::vector< std::string >	getUnresolvedDependencies () const
	returns the names of all unresolved dependencies More...

	ManagedIceObject (ManagedIceObject const &other)

void	offeringTopic (const std::string &name)
	Registers a topic for retrival after initialization. More...

void	preambleGetTopic (std::string const &name)

void	setMetaInfo (const std::string &id, const VariantBasePtr &value)
	Allows to set meta information that can be queried live via Ice interface on the ArmarXManager. More...

void	startPeriodicTask (const std::string &uniqueName, std::function< void(void)> f, int periodMs, bool assureMeanInterval=false, bool forceSystemTime=true)

bool	stopPeriodicTask (const std::string &name)

bool	unsubscribeFromTopic (const std::string &name)
	Unsubscribe from a topic. More...

bool	usingProxy (const std::string &name, const std::string &endpoints="")
	Registers a proxy for retrieval after initialization and adds it to the dependency list. More...

void	usingTopic (const std::string &name, bool orderedPublishing=false)
	Registers a proxy for subscription after initialization. More...

void	waitForObjectScheduler ()
	Waits until the ObjectScheduler could resolve all dependencies. More...

void	waitForProxy (std::string const &name, bool addToDependencies)

Public Member Functions inherited from Logging
SpamFilterDataPtr	deactivateSpam (float deactivationDurationSec=10.0f, const std::string &identifier="", bool deactivate=true) const
	disables the logging for the current line for the given amount of seconds. More...

MessageTypeT	getEffectiveLoggingLevel () const

	Logging ()

void	setLocalMinimumLoggingLevel (MessageTypeT level)
	With setLocalMinimumLoggingLevel the minimum verbosity-level of log-messages can be set. More...

void	setTag (const LogTag &tag)

void	setTag (const std::string &tagName)

virtual	~Logging ()

Public Member Functions inherited from PropertyUser
std::vector< std::string >	getComponentProxyNames ()

Ice::PropertiesPtr	getIceProperties () const
	Returns the set of Ice properties. More...

template<typename PropertyType >
Property< PropertyType >	getProperty (const std::string &name)
	Property creation and retrieval. More...

template<typename PropertyType >
Property< PropertyType >	getProperty (const std::string &name) const
	Hack to allow using getProperty in `const`-modified methods. More...

template<class T >
void	getProperty (std::atomic< T > &val, const std::string &name) const

template<class T >
void	getProperty (T &val, const std::string &name) const

template<class T >
std::vector< T >	getPropertyAsCSV (const std::string &name, const std::string &splitBy=",;", bool trimElements=true, bool removeEmptyElements=true)

template<class ContainerT >
void	getPropertyAsCSV (ContainerT &val, const std::string &name, const std::string &splitBy=",;", bool trimElements=true, bool removeEmptyElements=true)

PropertyDefinitionsPtr	getPropertyDefinitions ()
	Returns the component's property definition container. More...

std::vector< std::string >	getSubscribedTopicNames ()

std::vector< std::string >	getTopicProxyNames ()

bool	hasProperty (const std::string &name)

	PropertyUser ()

virtual void	setIceProperties (Ice::PropertiesPtr properties)
	Sets the Ice properties. More...

bool	tryAddProperty (const std::string &propertyName, const std::string &value)

virtual void	updateIceProperties (const std::map< std::string, std::string > &changes)

void	updateProperties ()

void	updateProxies (IceManagerPtr)

	~PropertyUser () override

Static Public Member Functions
template<class T , class TPtr = IceInternal::Handle<T>>
static TPtr	create (Ice::PropertiesPtr properties=Ice::createProperties(), const std::string &configName="", const std::string &configDomain="ArmarX")
	Factory method for a component. More...

Static Public Member Functions inherited from ManagedIceObject
static std::string	generateSubObjectName (const std::string &superObjectName, const std::string &subObjectName)
	Generates a unique name for a sub object from a general name and unique name. More...

static std::string	GetObjectStateAsString (int state)

Protected Member Functions
void	addPropertyUser (const PropertyUserPtr &subPropertyUser)
	Add additional property users here that should show up in the application help text. More...

	Component ()
	Protected default constructor. Used for virtual inheritance. Use createManagedIceObject() instead. More...

PropertyDefinitionsPtr	createPropertyDefinitions () override

std::string	getConfigDomain ()
	Retrieve config domain for this component as set in constructor. More...

std::string	getConfigIdentifier ()
	Retrieve config identifier for this component as set in constructor. More...

std::string	getConfigName ()
	Retrieve config name for this component as set in constructor. More...

virtual void	icePropertiesInitialized ()

Protected Member Functions inherited from ManagedIceObject
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)

Ice::CommunicatorPtr	getCommunicator () const

std::unique_ptr< ManagedIceObjectPlugin > &	getPluginPointer (std::type_info const &type, std::string const &prefix)

	ManagedIceObject ()
	Protected default constructor. More...

virtual void	onConnectComponent ()=0
	Pure virtual hook for the subclass. More...

virtual void	onDisconnectComponent ()
	Hook for subclass. More...

virtual void	onExitComponent ()
	Hook for subclass. More...

virtual void	onInitComponent ()=0
	Pure virtual hook for the subclass. More...

virtual void	postOnConnectComponent ()

virtual void	postOnDisconnectComponent ()

virtual void	postOnExitComponent ()

virtual void	postOnInitComponent ()

virtual void	preOnDisconnectComponent ()

virtual void	preOnExitComponent ()

bool	removeProxyDependency (const std::string &name)
	This function removes the dependency of this object on the in parameter name specified object. More...

void	setName (std::string name)
	Override name of well-known object. More...

void	terminate ()
	Initiates termination of this IceManagedObject. More...

	~ManagedIceObject () override

Protected Member Functions inherited from Logging
bool	checkLogLevel (MessageTypeT level) const

const LogSenderPtr &	getLogSender () const
	Retrieve log sender. More...

LogSenderPtr	loghelper (const char file, int line, const char function) const

Friends
class	ArmarXManager

Additional Inherited Members
Public Types inherited from ManagedIceObject
using	PeriodicTaskPtr = IceUtil::Handle< SimplePeriodicTask< std::function< void(void)> >>

Static Public Attributes inherited from ManagedIceObject
static const ManagedIceObjectPtr	NullPtr
	A nullptr to be used when a const ref to a nullptr is required. More...

Protected Attributes inherited from Logging
MessageTypeT	minimumLoggingLevel

SpamFilterDataPtr	spamFilter

LogTag	tag

Detailed Description

Baseclass for all ArmarX ManagedIceObjects requiring properties.

Components are the equivalents to ManagedIceObjects with additional properties. Usually, an ArmarX distributed application consists mainly of Component instances, which are configured on startup through properties specified in a config file (

See also: ArmarXCore-HowTos-generate-scenarios).

It is also possible for components to be reconfigured at runtime. To prepare your component for this feature you need to override the Component::componentPropertiesUpdated() method, which is called every time properties change.

The lifecycle of each Component is managed by an instance of ArmarXManager.

Definition at line 95 of file Component.h.

Constructor & Destructor Documentation

◆ Component()

Component ( )

protected

Protected default constructor. Used for virtual inheritance. Use createManagedIceObject() instead.

Definition at line 50 of file Component.cpp.

Here is the call graph for this function:

Member Function Documentation

◆ addPropertyUser()

void addPropertyUser ( const PropertyUserPtr & subPropertyUser )

protected

Add additional property users here that should show up in the application help text.

This function needs to be called in the icePropertiesInitialized from the component user.

Parameters

subPropertyUser

Definition at line 140 of file Component.cpp.

◆ componentPropertiesUpdated()

void componentPropertiesUpdated ( const std::set< std::string > & changedProperties )

virtual

Implement this function if you would like to react to changes in the properties.

Parameters

changedProperties Set of changed properties. Retrieve the values with getProperty()

Reimplemented in ModuleBase, ImageProcessor, TrajectoryControllerSubUnit, LaserScannerSelfLocalisation, TCPControllerSubUnit, RobotUnitSimulation, and VoxelGridMappingProvider.

Definition at line 276 of file Component.cpp.

◆ create()

static TPtr create	(	Ice::PropertiesPtr	properties = `Ice::createProperties()`,
		const std::string &	configName = `""`,
		const std::string &	configDomain = `"ArmarX"`
	)

inlinestatic

Factory method for a component.

Sets the specified properties.

The properties are identified using a config domain, a config name and a property name. The identifier of properties follows the rule:

configDomain.configName.propertyName

The configName is used as name of the well-known object in Ice.

See also: ManagedIceObject::ManagedIceObject(std::string name) This name can be changed by setting the property:

configDomain.configName.ObjectName=<desiredname>

Parameters

configName	name of the properties identifier
properties	properties for the object
configDomain	domain of the properties identifier

Definition at line 119 of file Component.h.

◆ createPropertyDefinitions()

PropertyDefinitionsPtr createPropertyDefinitions ( )

overrideprotectedvirtual

See also: PropertyUser::createPropertyDefinitions()

Implements PropertyUser.

Reimplemented in ArVizInteractExample, KBMComponent, ImageProcessor, Simulator, PrimitiveExtractor, TrajectoryPlayer, DenseCRFSegmentationProcessor, IEEE1394ImageProvider, ObstacleAvoidingPlatformUnit, RobotUnit, CoFusionProcessor, LaserScannerSelfLocalisation, ObstacleAwarePlatformUnit, ObjectLearningByPushing, TrajectoryControllerSubUnit, OpenNIPointCloudProvider, RobotUnitSimulation, OpenPoseEstimation, GraspingManager, PointCloudSegmenter, PointCloudObjectLocalizer, KinematicUnitSimulation, KLGImageProvider, ObjectLocalizationSaliency, TCPControlUnit, MaskRCNNPointCloudObjectLocalizer, ImageSequenceProvider, TabletopSegmentation, SimpleRobotPlacement, MultiSensePointCloudProvider, ReflexCombination, KinectV2PointCloudProvider, ResultPointCloudProvider, LaserScannerSimulation, CollisionCheckerComponent, CropRobotFromImage, ConditionHandler, AffordanceExtraction, RobotStateComponent, Component, ATINetFTUnit, HapticObserver, AffordancePipelineVisualization, CalibrationCreator2, ImageSourceSelection, ViewSelection, HokuyoLaserUnit, PointCloudVisualization, DSObstacleAvoidance, HandUnit, ImageProviderDynamicSimulation, FrameTracking, VisualContactDetection, ArmarXSimulatorWindow, MMMSimulation, RemoteGuiExample2, DebugDrawerComponent, ResultImageFuser, MotionPlanningServer, KinematicUnit, DMPComponent, StereoImagePointCloudProvider, SceneModifier, Component, RemoteObjectNode, KinectV1PointCloudProvider, RCPointCloudProvider, RobotIK, RTABMapRegistration, OpticalFlow, DeepFaceRecognition, StatechartContext, RGBDHandLocalizer, FaceRecognition, DHParameterOptimizationLogger, OrientedTactileSensorUnit, PointCloudRecorder, PrimitiveVisualization, KinematicUnitDynamicSimulation, SimpleGraspGenerator, XMLStateComponent, SkillsMemory, RCImageProvider, SegmentableTemplateRecognition, FakePointCloudProvider, PointCloudUtility, RobotHealth, OptoForceUnit, ObjectMemoryObserver, ObjectLocalizerProcessor, KinectAndCameraCalibration, IntelRealSenseProvider, TopicRecorderComponent, PlatformUnit, RobotPoseUnit, EntityDrawerComponent, FlyCaptureImageProvider, PointCloudFilter, PlannedMotionProvider, AzureKinectPointCloudProvider, KinematicSelfLocalization, NaturalIKTest, StereoCameraProvider, MaskFilterPointCloudProcessor, PointCloudToArViz, RobotHandLocalizationWithFingertips, UserAssistedSegmenter, GamepadControlUnit, PrimitiveExtractionParameterTuning, ArmarXPhysicsWorldVisualization, PlatformContext, MMMPlayer, GamepadUnit, CommonPlacesLearner, DummyObjectLocalizer, XMLSceneImporter, RobotPoseUnitDynamicSimulation, RobotHealthDummy, ValveAttention, VoxelGridMappingProvider, SemanticRelationAnalyzer, ShapesSupportRelations, HumanObstacleDetection, SegmentRansacShapeExtractor, DummyAgentReporter, CalibrationCreator, OLPEvaluation, LaserScannerPointCloudProvider, LongtermMemory, CyberGloveObserver, WorkingMemoryObjectPoseProvider, MultiImageProvider, BigBowlLocalization, ViconMarkerProvider, TCPControllerSubUnit, DummyArMarkerLocalizer, LabeledPointCloudMerger, ObjectLocalizationMemoryUpdater, RemoteGuiProvider, KinematicUnitObserver, DummyTextToSpeech, PlatformUnitObserver, MetaWearIMU, TrackingError, StaticAgentReporter, HeadIKUnit, MultiViewPointCloudProcessor, DummyWorldStateObserver, StreamDecoderImageProvider, SegmentAABBShapesProvider, SegmentSpatialRelations, FakeWorkingMemoryObjectLocalizer, HandUnitDynamicSimulation, SelfLocalization, KITProstheticHandUnit, InertialMeasurementUnit, UCLObjectRecognition, KITProstheticHandObserver, AffordanceUpdateListener, BlurrinessMetric, SegmentableObjectRecognition, LaserScannerFeatureExtraction, ForceTorqueObserver, ForceTorqueUnitSimulation, AbstractWorkingMemory, Component, AzureKinectIRImageProvider, SimoxSceneImporter, SemanticGraphStorage, RobotToArViz, TopicTimingClient, ForceTorqueUnit, WorkingMemory, WorkingMemoryToArViz, OpenCVImageStabilizer, EfficientRANSACPrimitiveExtractor, XsensIMU, TexturedObjectRecognition, RTUnit, CommonStorage, WebCamImageProvider, DebugDrawerToArVizComponent, RobotDefinition, RobotStatechartContext, ArMarkerExternalCameraCalibration, RobotNameService, StatechartExecutorExample, HandUnitSimulation, OpenPoseSimulation, BlobRecognition, SimulatorToArviz, RobotStateMemory, DebugObserver, DynamicObstacleManager, TopicTimingServer, PathPlanner, Component, ArVizExample, InertialMeasurementUnitObserver, ColorMarkerObjectLocalizer, LaserScannerObstacleDetection, Component, ObjectMemory, KITHandUnit, MultiHandUnit, OptoForceUnitObserver, RobotControl, SemanticGraphExample, ForceTorqueUnitDynamicSimulation, HapticUnit, OrientedTactileSensorUnitObserver, SimpleEpisodicMemoryImageConnector, Component, GamepadUnitObserver, PointCloudToArMem, SimpleEpisodicMemorySemanticGraphConnector, IMUSimulation, PlatformUnitDynamicSimulation, ExampleMemory, TopicReplayer, LaserScannerUnitObserver, PlatformUnitSimulation, RobotStateObserver, GraphNodePoseResolver, PlaybackImageProvider, FilterKnownObjects, DepthImageProviderDynamicSimulation, Component, ArMarkerLocalizerOpenCV, HandMarkerLocalization, RobotHandLocalizationDynamicSimulation, Component, MemoryNameSystem, ObjectPoseProviderExample, GraspCandidateObserver, MetaWearIMUObserver, TCPControlUnitObserver, PriorKnowledge, VideoFileImageProvider, Component, ExampleMemoryClient, Component, SimpleEpisodicMemoryKinematicUnitConnector, ArticulatedObjectLocalizerDynamicSimulation, LegacyRobotStateMemoryAdapter, AbstractLongtermMemory, Component, Component, SpeechObserver, GraspingManagerTest, WorkingMemoryUpdater, StreamProviderI, GraspSelectionCriterionBase, SimpleEpisodicMemoryPlatformUnitConnector, Component, GeneralPurposeMemory, ProfilerStorage, ArMarkerLocalizer, Component, Component, ArVizStorage, ik_demo, SkillProviderExample, CommonPlacesTester, SimpleEpisodicMemoryWorkingMemoryConnector, Component, ObjectInstanceToIndex, ObjectPoseClientExample, PriorKnowledgeImporter, SimpleEpisodicMemory, WorldStateUpdaterBase, LaserScansMemory, MemoryGrapher, PersonMemoryDebugger, ObjectLocalizerDynamicSimulation, WeissHapticUnit, Component, Component, Component, IndexMemory, GraspablePredicateProvider, VirtualRobotReaderExampleClient, MotionMemory, Component, ArmarXObjectsImporter, HumanMemory, HapticUnitDynamicSimulation, GraspSelectionManager, PutAwayLocationPredicateProvider, ImageToArMem, SimpleEpisodicMemoryOpenPoseEstimationConnector, SimulationObjectPoseProvider, AronComponentConfigExample, ArMemToImageProvider, HandControlSkillProvider, PlatformControlSkillProvider, SubjectMemory, AgentAtPredicateProvider, ObjectAtPredicateProvider, VisionMemory, JointControlSkillProvider, TCPControlSkillProvider, VisualSearchSkillProvider, VisualServoTCPControlSkillProvider, WorkingMemoryExample, AStarPathPlannerTestComponent, GraspMemory, HandPredicateProvider, Component, GraspControlSkillProvider, PersonInstanceUpdater, SelfLocalizationDynamicSimulation, DummyCriterion, NaturalGraspFilter, BringObjectSkillProvider, RGBDPoseEstimationWithMemoryWriter, Component, ArticulatedObjectLocalizerExample, ArMemToPointCloudProvider, SystemStateMemory, Component, VirtualRobotWriterExample, ReasoningMemory, LegacyRGBOpenPoseEstimation, LegacyRGBDOpenPoseEstimation, X11ScreenCaptureImageProvider, SimpleVirtualRobot, RGBDOpenPoseEstimation, GraspProviderExample, ObjectMemoryEditor, OpenNIImageProvider, ImageToPointCloud, FindAndGraspObjectContext, StreamReceiver, OptoForce, and ObjectShapeClassification.

Definition at line 207 of file Component.cpp.

Here is the call graph for this function:

◆ forceComponentCreatedByComponentCreateFunc()

void forceComponentCreatedByComponentCreateFunc ( )

forces the flag to be set to true that the object instance was created by the Component::create function

Note: Do not call this function except you know that you are doing.

Definition at line 174 of file Component.cpp.

◆ getAdditionalPropertyUsers()

std::vector< PropertyUserPtr > getAdditionalPropertyUsers ( ) const

Definition at line 147 of file Component.cpp.

◆ getConfigDomain()

std::string getConfigDomain ( )

protected

Retrieve config domain for this component as set in constructor.

The configdomain defines which properties are used from the properties read from commandline or config file. The name of the used properties follows the rule:

configDomain.configName.propertyName

Definition at line 60 of file Component.cpp.

Here is the caller graph for this function:

◆ getConfigIdentifier()

std::string getConfigIdentifier ( )

protected

Retrieve config identifier for this component as set in constructor.

The config identifier defines which properties are used from the properties read from commandline or config file. The name of the properties follows the rule:

configDomain.configName.propertyName

where the configIdentifier corresponds to

configDomain.configName

Definition at line 74 of file Component.cpp.

◆ getConfigName()

std::string getConfigName ( )

protected

Retrieve config name for this component as set in constructor.

The configname defines which properties are used from the properties read from commandline or config file. The name of the properties follows the rule:

configDomain.configName.propertyName

Definition at line 67 of file Component.cpp.

Here is the caller graph for this function:

◆ getProperty() [1/4]

Property< PropertyType > getProperty ( typename PropertyType )

See also: PropertyUser::getProperty()

Definition at line 179 of file PropertyUser.h.

◆ getProperty() [2/4]

Property<PropertyType> getProperty ( typename PropertyType )

inline

See also: PropertyUser::getProperty()

Definition at line 84 of file PropertyUser.h.

◆ getProperty() [3/4]

void getProperty ( class T )

inline

See also: PropertyUser::getProperty()

Definition at line 204 of file PropertyUser.h.

◆ getProperty() [4/4]

void getProperty ( class T )

inline

See also: PropertyUser::getProperty()

Definition at line 189 of file PropertyUser.h.

◆ getProxyFromProperty() [1/2]

ProxyType getProxyFromProperty	(	const std::string &	propertyName,
		bool	addToDependencies = `false`,
		const std::string &	endpoints = `""`,
		bool	throwOnProxyError = `true`
	)

inline

Get a proxy whose name is specified by the given property.

Parameters

name	Name of the property specifying the proxy name.

Returns: The proxy. (See ManagedIceObject::getProxy().)

See also: ManagedIceObject::getProxy(); PropertyUser::getProperty()

Definition at line 236 of file Component.h.

Here is the caller graph for this function:

◆ getProxyFromProperty() [2/2]

void getProxyFromProperty	(	ProxyType &	proxy,
		const std::string &	propertyName,
		bool	addToDependencies = `false`,
		const std::string &	endpoints = `""`,
		bool	throwOnProxyError = `true`
	)

inline

Definition at line 245 of file Component.h.

◆ getTopicFromProperty() [1/2]

TopicProxyType getTopicFromProperty ( const std::string & propertyName )

inline

Get a topic proxy whose name is specified by the given property.

Parameters

name	Name of the property specifying the proxy name.

Returns: The topic proxy. (See ManagedIceObject::getProxy().)

See also: ManagedIceObject::getTopic(); PropertyUser::getProperty()

Definition at line 218 of file Component.h.

Here is the caller graph for this function:

◆ getTopicFromProperty() [2/2]

void getTopicFromProperty	(	TopicProxyType &	top,
		const std::string &	propertyName
	)

inline

Definition at line 223 of file Component.h.

◆ icePropertiesInitialized()

virtual void icePropertiesInitialized ( )

inlineprotectedvirtual

Reimplemented in ModuleBase.

Definition at line 297 of file Component.h.

Here is the caller graph for this function:

◆ initializeProperties()

void initializeProperties	(	const std::string &	configName,
		Ice::PropertiesPtr const &	properties,
		const std::string &	configDomain
	)

initializes the properties of this component.

Must not be called after the component was added to the ArmarXManager. Use with caution!

Parameters

configName
properties
configDomain

Definition at line 81 of file Component.cpp.

Here is the call graph for this function:

◆ injectPropertyDefinitions()

void injectPropertyDefinitions ( PropertyDefinitionsPtr & props )

overridevirtual

See also: PropertyUser

Reimplemented from PropertyUser.

Definition at line 181 of file Component.cpp.

Here is the call graph for this function:

◆ offeringTopicFromProperty()

void offeringTopicFromProperty ( const std::string & propertyName )

Offer a topic whose name is specified by the given property.

Parameters

name	Name of the property specifying the topic name.

See also: ManagedIceObject::offeringTopic(); PropertyUser::getProperty()

Definition at line 154 of file Component.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ preOnConnectComponent()

void preOnConnectComponent ( )

overridevirtual

Reimplemented from ManagedIceObject.

Reimplemented in Base.

Definition at line 131 of file Component.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ preOnInitComponent()

void preOnInitComponent ( )

overridevirtual

Reimplemented from ManagedIceObject.

Definition at line 99 of file Component.cpp.

Here is the call graph for this function:

◆ usingProxyFromProperty()

bool usingProxyFromProperty	(	const std::string &	propertyName,
		const std::string &	endpoints = `""`
	)

Use a proxy whose name is specified by the given property.

Parameters

name	Name of the property specifying the proxy name.
endpoints	See ManagedIceObject::usingProxy().

Returns: See ManagedIceObject::usingProxy().

See also: ManagedIceObject::usingProxy(); PropertyUser::getProperty()

Definition at line 167 of file Component.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ usingTopicFromProperty()

void usingTopicFromProperty	(	const std::string &	propertyName,
		bool	orderedPublishing = `false`
	)

Use a topic whose name is specified by the given property.

Parameters

name	Name of the property specifying the topic name.
orderedPublishing	See ManagedIceObject::usingProxy().

See also: ManagedIceObject::usingTopic(); PropertyUser::getProperty()

Definition at line 160 of file Component.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

Friends And Related Function Documentation

◆ ArmarXManager

friend class ArmarXManager

friend

Definition at line 309 of file Component.h.

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

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

Public Member Functions

Static Public Member Functions

Protected Member Functions

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Component()

Member Function Documentation

◆ addPropertyUser()

◆ componentPropertiesUpdated()

◆ create()

◆ createPropertyDefinitions()

◆ forceComponentCreatedByComponentCreateFunc()

◆ getAdditionalPropertyUsers()

◆ getConfigDomain()

◆ getConfigIdentifier()

◆ getConfigName()

◆ getProperty() [1/4]

◆ getProperty() [2/4]

◆ getProperty() [3/4]

◆ getProperty() [4/4]

◆ getProxyFromProperty() [1/2]

◆ getProxyFromProperty() [2/2]

◆ getTopicFromProperty() [1/2]

◆ getTopicFromProperty() [2/2]

◆ icePropertiesInitialized()

◆ initializeProperties()

◆ injectPropertyDefinitions()

◆ offeringTopicFromProperty()

◆ preOnConnectComponent()

◆ preOnInitComponent()

◆ usingProxyFromProperty()

◆ usingTopicFromProperty()

Friends And Related Function Documentation

◆ ArmarXManager