Abstract PropertyUser class. More...
#include <ArmarXCore/core/application/properties/PropertyUser.h>
Inheritance diagram for PropertyUser:Classes | |
| 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 63 of file PropertyUser.h.
Constructor & Destructor Documentation
◆ PropertyUser()
| PropertyUser | ( | ) |
Definition at line 50 of file PropertyUser.cpp.
◆ ~PropertyUser()
|
override |
Definition at line 54 of file PropertyUser.cpp.
Member Function Documentation
◆ 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, Simulator, ImageProcessor, EmergencyStopNode< T >, Application, LaserScannerSelfLocalisation, TrajectoryPlayer, DenseCRFSegmentationProcessor, Component, PrimitiveExtractor, OpenPoseEstimation, CoFusionProcessor, GraspingManager, RobotUnitSimulation, IEEE1394ImageProvider, RobotUnit, PointCloudSegmenter, CollisionCheckerComponent, ObjectLearningByPushing, ObjectLocalizationSaliency, ReflexCombination, TrajectoryControllerSubUnit, EmergencyStopMaster, LaserScannerSimulation, ImageSequenceProvider, KinematicUnitSimulation, OpenNIPointCloudProvider, AffordancePipelineVisualization, SceneModifier, TCPControlUnit, AffordanceExtraction, MaskRCNNPointCloudObjectLocalizer, TabletopSegmentation, FrameTracking, CropRobotFromImage, KLGImageProvider, PointCloudObjectLocalizer, ViewSelection, KinectV2PointCloudProvider, MultiSensePointCloudProvider, SimpleRobotPlacement, ConditionHandler, VisualContactDetection, ObstacleAvoidingPlatformUnit, ObstacleAwarePlatformUnit, PointCloudVisualization, ImageProviderDynamicSimulation, ATINetFTUnit, ImageSourceSelection, ArmarXSimulatorWindow, ObjectMemoryObserver, Component, CalibrationCreator2, HapticObserver, MotionPlanningServer, KinematicUnit, ResultPointCloudProvider, StereoImagePointCloudProvider, RobotStateComponent, HandUnit, HokuyoLaserUnit, CommonPlacesLearner, MMMSimulation, DeepFaceRecognition, DebugDrawerComponent, SimpleGraspGenerator, ObjectLocalizationMemoryUpdater, RemoteObjectNode, ResultImageFuser, SegmentableTemplateRecognition, KinematicUnitDynamicSimulation, ObjectLocalizerProcessor, MaskFilterPointCloudProcessor, DHParameterOptimizationLogger, LongtermMemory, OpticalFlow, IntelRealSenseProvider, VoxelGridMappingProvider, EntityDrawerComponent, RobotIK, XMLStateComponent, SkillsMemory, FaceRecognition, KinectV1PointCloudProvider, RGBDHandLocalizer, RemoteGuiExample2, RCPointCloudProvider, ArmarXTimeserver, PointCloudUtility, PlatformContext, Component, RTABMapRegistration, KinematicSelfLocalization, TopicRecorderComponent, KinematicUnitObserver, StatechartContext, PointCloudRecorder, PrimitiveVisualization, DMPComponent, PlatformUnit, KinectAndCameraCalibration, RobotPoseUnit, OptoForceUnit, RCImageProvider, OrientedTactileSensorUnit, RobotHandLocalizationWithFingertips, PrimitiveExtractionParameterTuning, RobotPoseUnitDynamicSimulation, RobotHealth, FlyCaptureImageProvider, PlannedMotionProvider, FakePointCloudProvider, ForceTorqueObserver, LaserScannerPointCloudProvider, GamepadUnit, TexturedObjectRecognition, MMMPlayer, DSObstacleAvoidance, StereoCameraProvider, AzureKinectPointCloudProvider, ArmarXPhysicsWorldVisualization, DummyObjectLocalizer, SegmentableObjectRecognition, XMLSceneImporter, PointCloudToArViz, PointCloudFilter, BigBowlLocalization, ArmarXGuiApp, CalibrationCreator, ValveAttention, GamepadControlUnit, SemanticRelationAnalyzer, RobotHealthDummy, DummyAgentReporter, OLPEvaluation, BlobRecognition, UCLObjectRecognition, MultiViewPointCloudProcessor, UserAssistedSegmenter, HumanObstacleDetection, NaturalIKTest, HeadIKUnit, PlatformUnitObserver, ViconMarkerProvider, AbstractWorkingMemory, DummyArMarkerLocalizer, CyberGloveObserver, ShapesSupportRelations, SimpleStatechartExecutor, SegmentRansacShapeExtractor, StaticAgentReporter, ExternalApplicationManager, RemoteGuiProvider, MetaWearIMU, SimulatorViewerApp, HandUnitDynamicSimulation, TCPControllerSubUnit, RobotStatechartContext, BlurrinessMetric, TrackingError, StreamDecoderImageProvider, LaserScannerFeatureExtraction, DummyTextToSpeech, DynamicObstacleManager, ForceTorqueUnitSimulation, OrientedTactileSensorUnitObserver, ForceTorqueUnitDynamicSimulation, WorkingMemory, WorkingMemoryObjectPoseProvider, KITProstheticHandUnit, InertialMeasurementUnit, DummyWorldStateObserver, HandMarkerLocalization, MultiImageProvider, FakeWorkingMemoryObjectLocalizer, PlatformUnitDynamicSimulation, SelfLocalization, AffordanceUpdateListener, LabeledPointCloudMerger, ForceTorqueUnit, KITProstheticHandObserver, InertialMeasurementUnitObserver, OptoForceUnitObserver, PlatformUnitSimulation, WebCamImageProvider, ColorMarkerObjectLocalizer, SimoxSceneImporter, OpenCVImageStabilizer, SegmentAABBShapesProvider, SegmentSpatialRelations, CommonStorage, Component, AzureKinectIRImageProvider, RTUnit, EfficientRANSACPrimitiveExtractor, SemanticGraphStorage, LegacyRobotStateMemoryAdapter, CommonPlacesTester, SimpleEpisodicMemoryImageConnector, RobotDefinition, HandUnitSimulation, RobotControl, RobotNameService, RobotToArViz, GraphNodePoseResolver, RobotHandLocalizationDynamicSimulation, RobotStateMemory, TopicTimingClient, XsensIMU, PriorKnowledge, ArMarkerExternalCameraCalibration, SimulatorToArviz, Component, Component, DebugObserver, GamepadUnitObserver, WorkingMemoryToArViz, OpenPoseSimulation, SimpleEpisodicMemorySemanticGraphConnector, Component, GraspCandidateObserver, DemoStateManager, DebugDrawerToArVizComponent, LaserScannerUnitObserver, RobotStateObserver, LaserScannerObstacleDetection, PathPlanner, TopicReplayer, ExampleMemory, ArVizExample, HapticUnit, MetaWearIMUObserver, PointCloudToArMem, Component, ObjectMemory, SpeechObserver, Component, Component, KITHandUnit, StatechartExecutorExample, TCPControlUnitObserver, WorkingMemoryUpdater, PingLoadTest, TopicTimingServer, GraspablePredicateProvider, PlaybackImageProvider, VideoFileImageProvider, DepthImageProviderDynamicSimulation, GraspingManagerTest, AbstractLongtermMemory, FilterKnownObjects, SemanticGraphExample, SimpleEpisodicMemoryKinematicUnitConnector, Component, PythonApplicationManager, Component, MultiHandUnit, ArMarkerLocalizerOpenCV, MemoryNameSystem, ObjectPoseProviderExample, IMUSimulation, HapticUnitDynamicSimulation, GraspSelectionCriterionBase, Component, ExampleMemoryClient, SkillProviderExample, WorldStateUpdaterBase, Component, Component, ArticulatedObjectLocalizerDynamicSimulation, StreamProviderI, SimpleEpisodicMemoryPlatformUnitConnector, ObjectInstanceToIndex, ArVizStorage, PutAwayLocationPredicateProvider, PriorKnowledgeImporter, Component, Component, LaserScansMemory, SimpleEpisodicMemoryWorkingMemoryConnector, AgentAtPredicateProvider, Component, Component, ArmarXFileLogger, GraspMemory, ik_demo, ProfilerStorage, ObjectAtPredicateProvider, ArMarkerLocalizer, PersonMemoryDebugger, GeneralPurposeMemory, ObjectPoseClientExample, WeissHapticUnit, SimpleEpisodicMemory, ObjectLocalizerDynamicSimulation, MemoryGrapher, WorkingMemoryExample, SimpleEpisodicMemoryOpenPoseEstimationConnector, IndexMemory, AStarPathPlannerTestComponent, Component, HumanMemory, Component, GraspSelectionManager, VirtualRobotReaderExampleClient, Component, ImageToArMem, SimulationObjectPoseProvider, AronComponentConfigExample, HandPredicateProvider, ArMemToImageProvider, VisionMemory, HandControlSkillProvider, PlatformControlSkillProvider, MotionMemory, ArmarXObjectsImporter, JointControlSkillProvider, TCPControlSkillProvider, VisualSearchSkillProvider, VisualServoTCPControlSkillProvider, SubjectMemory, DummyCriterion, NaturalGraspFilter, Component, PersonInstanceUpdater, GraspControlSkillProvider, FamiliarObjectDetectionExample, SelfLocalizationDynamicSimulation, ArticulatedObjectLocalizerExample, ArMemToPointCloudProvider, BringObjectSkillProvider, RGBDPoseEstimationWithMemoryWriter, Component, VirtualRobotWriterExample, Component, SystemStateMemory, ReasoningMemory, JsonStorage, LegacyRGBOpenPoseEstimation, LegacyRGBDOpenPoseEstimation, RGBDOpenPoseEstimation, X11ScreenCaptureImageProvider, SimpleVirtualRobot, Component, GraspProviderExample, ObjectMemoryEditor, OpenNIImageProvider, ImageToPointCloud, FindAndGraspObjectContext, StreamReceiver, ObjectShapeClassification, and OptoForce.
Here is the caller graph for this function:◆ getComponentProxyNames()
| std::vector< std::string > getComponentProxyNames | ( | ) |
Definition at line 163 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 221 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
-
name Requested property name (note: without prefix)
- Returns
- Property instance
Definition at line 180 of file PropertyUser.h.
Here is the call graph for this function: Here is the caller graph for this function:◆ getProperty() [2/4]
|
inline |
Hack to allow using getProperty in const-modified methods.
Definition at line 85 of file PropertyUser.h.
Here is the call graph for this function:◆ getProperty() [3/4]
|
inline |
Definition at line 206 of file PropertyUser.h.
◆ getProperty() [4/4]
|
inline |
◆ getPropertyAsCSV() [1/2]
|
inline |
◆ getPropertyAsCSV() [2/2]
|
inline |
Definition at line 214 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 60 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 191 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 177 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 | ) |
◆ icePropertiesUpdated()
|
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 214 of file PropertyUser.cpp.
Here is the caller graph for this function:◆ injectPropertyDefinitions()
|
virtual |
Called after createPropertyDefinitions by Component to inject propertes of ComponentPlugin.
Reimplemented in Component.
Definition at line 81 of file PropertyUser.cpp.
Here is the caller graph for this function:◆ setIceProperties()
|
virtual |
Sets the Ice properties.
- Parameters
-
properties Ice Properties.
Reimplemented in Application.
Definition at line 87 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 203 of file PropertyUser.cpp.
Here is the call graph for this function: Here is the caller graph for this function:◆ updateIceProperties()
|
virtual |
Definition at line 112 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 151 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 157 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:
- ArmarXCore/core/application/properties/PropertyUser.h
- ArmarXCore/core/application/properties/PropertyUser.cpp
