Data Structures | Public Member Functions
PropertyUser Class Referenceabstract

Abstract PropertyUser class. More...

#include <ArmarXCore/core/application/properties/PropertyUser.h>

+ Inheritance diagram for PropertyUser:

Data Structures

struct  Impl
 

Public Member Functions

virtual PropertyDefinitionsPtr createPropertyDefinitions ()=0
 Creates the property definition container. More...
 
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)
 
virtual void icePropertiesUpdated (const std::set< std::string > &changedProperties)
 This method is called when new Properties are set via setIceProperties(). More...
 
virtual void injectPropertyDefinitions (PropertyDefinitionsPtr &)
 Called after createPropertyDefinitions by Component to inject propertes of ComponentPlugin. More...
 
 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
 

Detailed Description

Abstract PropertyUser class.

PropertyUser provides the interface to create a PropertyDefinition as well as the access to each property which has been defined.

Properties can be updated by calling PropertyUser::setIceProperties(). A class inheriting from PropertyUser can react to property changes by overriding PropertyUser::propertiesUpdated();

Definition at line 62 of file PropertyUser.h.

Constructor & Destructor Documentation

◆ PropertyUser()

PropertyUser ( )

Definition at line 48 of file PropertyUser.cpp.

◆ ~PropertyUser()

~PropertyUser ( )
override

Definition at line 54 of file PropertyUser.cpp.

Member Function Documentation

◆ createPropertyDefinitions()

virtual PropertyDefinitionsPtr createPropertyDefinitions ( )
pure virtual

Creates the property definition container.

Note
Implement this factory function to create your own definitions.
Returns
Property definition container pointer

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

+ Here is the caller graph for this function:

◆ getComponentProxyNames()

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

Definition at line 168 of file PropertyUser.cpp.

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

◆ getIceProperties()

Ice::PropertiesPtr getIceProperties ( ) const

Returns the set of Ice properties.

Returns
Pointer to the Ice::Properties set.

Definition at line 229 of file PropertyUser.cpp.

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

◆ getProperty() [1/4]

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

Property creation and retrieval.

Parameters
nameRequested property name (note: without prefix)
Returns
Property instance

Definition at line 179 of file PropertyUser.h.

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

◆ getProperty() [2/4]

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

Hack to allow using getProperty in const-modified methods.

Definition at line 84 of file PropertyUser.h.

+ Here is the call graph for this function:

◆ getProperty() [3/4]

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

Definition at line 202 of file PropertyUser.h.

◆ getProperty() [4/4]

void getProperty ( T &  val,
const std::string &  name 
) const
inline

Definition at line 188 of file PropertyUser.h.

+ Here is the call graph for this function:

◆ getPropertyAsCSV() [1/2]

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

Definition at line 239 of file PropertyUser.h.

+ Here is the call graph for this function:

◆ getPropertyAsCSV() [2/2]

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

Definition at line 208 of file PropertyUser.h.

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

◆ getPropertyDefinitions()

PropertyDefinitionsPtr getPropertyDefinitions ( )

Returns the component's property definition container.

Returns
Property definition container

Definition at line 61 of file PropertyUser.cpp.

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

◆ getSubscribedTopicNames()

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

Definition at line 198 of file PropertyUser.cpp.

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

◆ getTopicProxyNames()

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

Definition at line 183 of file PropertyUser.cpp.

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

◆ hasProperty()

bool hasProperty ( const std::string &  name)

Definition at line 243 of file PropertyUser.cpp.

+ Here is the caller graph for this function:

◆ icePropertiesUpdated()

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

This method is called when new Properties are set via setIceProperties().

Each class deriving from PropertyUser can overwrite this method in order to react to changed properties.

Reimplemented in Application.

Definition at line 221 of file PropertyUser.cpp.

+ Here is the caller graph for this function:

◆ injectPropertyDefinitions()

void injectPropertyDefinitions ( PropertyDefinitionsPtr &  )
virtual

Called after createPropertyDefinitions by Component to inject propertes of ComponentPlugin.

Reimplemented in Component.

Definition at line 82 of file PropertyUser.cpp.

+ Here is the caller graph for this function:

◆ setIceProperties()

void setIceProperties ( Ice::PropertiesPtr  properties)
virtual

Sets the Ice properties.

Parameters
propertiesIce Properties.

Reimplemented in Application.

Definition at line 89 of file PropertyUser.cpp.

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

◆ tryAddProperty()

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

Definition at line 209 of file PropertyUser.cpp.

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

◆ updateIceProperties()

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

Definition at line 115 of file PropertyUser.cpp.

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

◆ updateProperties()

void updateProperties ( )

Definition at line 154 of file PropertyUser.cpp.

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

◆ updateProxies()

void updateProxies ( IceManagerPtr  ice_manager)

Definition at line 161 of file PropertyUser.cpp.

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