OpenSim::PropertyStr Class Reference
#include <PropertyStr.h>
Public Member Functions | |
| PropertyStr () | |
| Default Constructor. | |
| PropertyStr (const std::string &aName, const std::string &aValue) | |
| PropertyStr (const PropertyStr &aProperty) | |
| Copy constructor. | |
| virtual Property * | copy () const |
| Construct and return a copy of this property. | |
| virtual | ~PropertyStr () |
| PropertyStr & | operator= (const PropertyStr &aProperty) |
| Assign this property to another. | |
| virtual const char * | getTypeAsString () const |
| Get the type of this property as a string. | |
| virtual void | setValue (const std::string &aValue) |
| virtual std::string & | getValueStr () |
| Get a reference to the value of this property. | |
| virtual const std::string & | getValueStr () 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 | clearValue () |
| bool | isValidFileName () |
Static Public Member Functions | |
| static const std::string & | getDefaultStr () |
Constructor & Destructor Documentation
| PropertyStr::PropertyStr | ( | ) |
Default Constructor.
| OpenSim::PropertyStr::PropertyStr | ( | const std::string & | aName, | |
| const std::string & | aValue | |||
| ) |
| PropertyStr::PropertyStr | ( | const PropertyStr & | aProperty | ) |
Copy constructor.
- Parameters:
-
aProperty Property to be copied.
| virtual OpenSim::PropertyStr::~PropertyStr | ( | ) | [inline, virtual] |
Member Function Documentation
| void OpenSim::PropertyStr::clearValue | ( | ) | [inline] |
| Property * PropertyStr::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.
| const std::string & PropertyStr::getDefaultStr | ( | ) | [static] |
| const char * PropertyStr::getTypeAsString | ( | ) | const [virtual] |
Get the type of this property as a string.
- Returns:
- Type of the property.
Reimplemented from OpenSim::Property.
| const string & PropertyStr::getValueStr | ( | ) | const [virtual] |
Get a constant reference to the value of this property.
- Returns:
- Reference to the value of this property.
Reimplemented from OpenSim::Property.
| string & PropertyStr::getValueStr | ( | ) | [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.
| bool OpenSim::PropertyStr::isValidFileName | ( | ) | [inline] |
| PropertyStr & PropertyStr::operator= | ( | const PropertyStr & | aProperty | ) |
Assign this property to another.
- Parameters:
-
aProperty Property to which to assign this property.
- Returns:
- Reference to this property.
Reimplemented from OpenSim::Property.
| virtual void OpenSim::PropertyStr::setValue | ( | const std::string & | aValue | ) | [virtual] |
Reimplemented from OpenSim::Property.
| const string & PropertyStr::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/PropertyStr.h
- OpenSim/Common/PropertyStr.cpp
