RcsPySim
A robot control and simulation library
Rcs::PropertySink Class Referenceabstract

#include <PropertySink.h>

Inheritance diagram for Rcs::PropertySink:
Collaboration diagram for Rcs::PropertySink:

Public Member Functions

 PropertySink ()
 
virtual ~PropertySink ()
 
virtual void setProperty (const char *property, const std::string &value)=0
 
virtual void setProperty (const char *property, bool value)=0
 
virtual void setProperty (const char *property, int value)=0
 
virtual void setProperty (const char *property, double value)=0
 
virtual void setProperty (const char *property, MatNd *value)=0
 
virtual PropertySinkgetChild (const char *prefix)=0
 
virtual PropertySinkclone () const =0
 
- Public Member Functions inherited from Rcs::PropertySource
 PropertySource ()
 
virtual ~PropertySource ()
 
virtual bool exists ()=0
 
virtual bool getProperty (std::string &out, const char *property)=0
 
virtual bool getProperty (std::vector< std::string > &out, const char *property)=0
 
virtual bool getProperty (double &out, const char *property)=0
 
virtual bool getProperty (int &out, const char *property)=0
 
virtual bool getProperty (MatNd *&out, const char *property)=0
 
virtual bool getPropertyBool (const char *property, bool def=false)=0
 
virtual const std::vector< PropertySource * > & getChildList (const char *prefix)=0
 
virtual void saveXML (const char *fileName, const char *rootNodeName)=0
 

Additional Inherited Members

- Static Public Member Functions inherited from Rcs::PropertySource
static PropertySourceempty ()
 

Detailed Description

Mutable version of PropertySource.

Note that this class does not specify any mechanism for persisting the changes made here.

Definition at line 46 of file PropertySink.h.

Constructor & Destructor Documentation

◆ PropertySink()

Rcs::PropertySink::PropertySink ( )

Definition at line 122 of file PropertySource.cpp.

◆ ~PropertySink()

Rcs::PropertySink::~PropertySink ( )
virtual

Definition at line 127 of file PropertySource.cpp.

Member Function Documentation

◆ clone()

virtual PropertySink* Rcs::PropertySink::clone ( ) const
pure virtual

Create an independent copy of this property source.

Returns
a copy of this property source. Must take ownership.

Implements Rcs::PropertySource.

Implemented in Rcs::PropertySourceDict.

◆ getChild()

virtual PropertySink* Rcs::PropertySink::getChild ( const char *  prefix)
pure virtual

Obtain a child property sink.

This only adapts the return type from the PropertySource definition.

Implements Rcs::PropertySource.

Implemented in Rcs::PropertySourceDict.

◆ setProperty() [1/5]

virtual void Rcs::PropertySink::setProperty ( const char *  property,
const std::string &  value 
)
pure virtual

Set a property to the given string value.

Parameters
[in]propertyname of property to write.
[in]valuenew property value.

Implemented in Rcs::PropertySourceDict.

◆ setProperty() [2/5]

virtual void Rcs::PropertySink::setProperty ( const char *  property,
bool  value 
)
pure virtual

Set a property to the given boolean value.

Parameters
[in]propertyname of property to write.
[in]valuenew property value.

Implemented in Rcs::PropertySourceDict.

◆ setProperty() [3/5]

virtual void Rcs::PropertySink::setProperty ( const char *  property,
int  value 
)
pure virtual

Set a property to the given integer value.

Parameters
[in]propertyname of property to write.
[in]valuenew property value.

Implemented in Rcs::PropertySourceDict.

◆ setProperty() [4/5]

virtual void Rcs::PropertySink::setProperty ( const char *  property,
double  value 
)
pure virtual

Set a property to the given double value.

Parameters
[in]propertyname of property to write.
[in]valuenew property value.

Implemented in Rcs::PropertySourceDict.

◆ setProperty() [5/5]

virtual void Rcs::PropertySink::setProperty ( const char *  property,
MatNd *  value 
)
pure virtual

Set a property to the given vector/matrix value.

If one of the dimensions of the matrix has size 1, it is interpreted as vector.

Parameters
[in]propertyname of property to write.
[in]valuenew property value.

Implemented in Rcs::PropertySourceDict.


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