OpenSim::PropertyObj Class Reference
#include <PropertyObj.h>
Public Member Functions | |
| PropertyObj () | |
| Default Constructor. | |
| PropertyObj (const std::string &aName, const Object &aValue) | |
| PropertyObj (const PropertyObj &aProperty) | |
| Copy constructor. | |
| virtual Property * | copy () const |
| Construct and return a copy of this property. | |
| virtual | ~PropertyObj () |
| Destructor. | |
| PropertyObj & | operator= (const PropertyObj &aProperty) |
| Assign this property to another. | |
| virtual bool | isValidObject (const Object *obj) const |
| virtual const char * | getTypeAsString () const |
| Get the type of this property as a string. | |
| virtual Object & | getValueObj () |
| Get a reference to the value of this property. | |
| virtual const Object & | getValueObj () const |
| Get a constant reference to the value of this property. | |
| virtual const std::string & | toString () |
| Get a constant String represeting the value of this property. | |
| void | setMatchName (bool aMatchName) |
| bool | getMatchName () const |
Constructor & Destructor Documentation
| PropertyObj::PropertyObj | ( | ) |
Default Constructor.
| OpenSim::PropertyObj::PropertyObj | ( | const std::string & | aName, | |
| const Object & | aValue | |||
| ) |
| PropertyObj::PropertyObj | ( | const PropertyObj & | aProperty | ) |
Copy constructor.
- Parameters:
-
aProperty Property to be copied.
| PropertyObj::~PropertyObj | ( | ) | [virtual] |
Destructor.
Member Function Documentation
| Property * PropertyObj::copy | ( | ) | const [virtual] |
Construct and return a copy of this property.
The property is allocated using the new operator, so the caller is responsible for deleting the returned object.
- Returns:
- Copy of this property.
Implements OpenSim::Property.
| bool OpenSim::PropertyObj::getMatchName | ( | ) | const [inline] |
| const char * PropertyObj::getTypeAsString | ( | ) | const [virtual] |
Get the type of this property as a string.
- Returns:
- Type of the property.
Reimplemented from OpenSim::Property.
| const Object & PropertyObj::getValueObj | ( | ) | const [virtual] |
Get a constant reference to the value of this property.
- Returns:
- Contant reference to the value of this property.
Reimplemented from OpenSim::Property.
| Object & PropertyObj::getValueObj | ( | ) | [virtual] |
Get a reference to the value of this property.
Note that the returned reference can be used to change the value of this property.
- Returns:
- Reference to the value of this property.
Reimplemented from OpenSim::Property.
| virtual bool OpenSim::PropertyObj::isValidObject | ( | const Object * | obj | ) | const [inline, virtual] |
Reimplemented from OpenSim::Property.
| PropertyObj & PropertyObj::operator= | ( | const PropertyObj & | aProperty | ) |
Assign this property to another.
- Parameters:
-
aProperty Property to which to assign this property.
- Returns:
- Reference to this property.
Reimplemented from OpenSim::Property.
| void OpenSim::PropertyObj::setMatchName | ( | bool | aMatchName | ) | [inline] |
| const string & PropertyObj::toString | ( | ) | [virtual] |
Get a constant String represeting the value of this property.
- Returns:
- Constant String represeting the value of this property.
Implements OpenSim::Property.
The documentation for this class was generated from the following files:
- OpenSim/Common/PropertyObj.h
- OpenSim/Common/PropertyObj.cpp
