OpenSim::PropertyBool Class Reference
#include <PropertyBool.h>
Public Member Functions | |
| PropertyBool () | |
| Default Constructor. | |
| PropertyBool (const std::string &aName, bool aValue) | |
| PropertyBool (const PropertyBool &aProperty) | |
| Copy constructor. | |
| virtual Property * | copy () const |
| Construct and return a copy of this property. | |
| virtual | ~PropertyBool () |
| PropertyBool & | operator= (const PropertyBool &aProperty) |
| Assign this property to another. | |
| virtual const char * | getTypeAsString () const |
| Get the type of this property as a string. | |
| virtual void | setValue (bool aValue) |
| Set the value of this property. | |
| virtual bool & | getValueBool () |
| Get a reference to the value of this property. | |
| virtual const bool & | getValueBool () const |
| Get a constant reference to the value of this property. | |
| virtual const std::string & | toString () |
| Get a String represeting the value of this property. | |
Constructor & Destructor Documentation
| PropertyBool::PropertyBool | ( | ) |
Default Constructor.
| OpenSim::PropertyBool::PropertyBool | ( | const std::string & | aName, | |
| bool | aValue | |||
| ) |
| PropertyBool::PropertyBool | ( | const PropertyBool & | aProperty | ) |
Copy constructor.
- Parameters:
-
aProperty Property to be copied.
| virtual OpenSim::PropertyBool::~PropertyBool | ( | ) | [inline, virtual] |
Member Function Documentation
| Property * PropertyBool::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 char * PropertyBool::getTypeAsString | ( | ) | const [virtual] |
Get the type of this property as a string.
- Returns:
- Type of the property.
Reimplemented from OpenSim::Property.
| const bool & PropertyBool::getValueBool | ( | ) | 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.
| bool & PropertyBool::getValueBool | ( | ) | [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.
| PropertyBool & PropertyBool::operator= | ( | const PropertyBool & | 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 PropertyBool::setValue | ( | bool | aValue | ) | [virtual] |
Set the value of this property.
- Parameters:
-
aValue Value to which this property is assigned.
Reimplemented from OpenSim::Property.
| const string & PropertyBool::toString | ( | ) | [virtual] |
Get a String represeting the value of this property.
- Returns:
- Constant reference to a String represeting the value of this property.
Implements OpenSim::Property.
The documentation for this class was generated from the following files:
- OpenSim/Common/PropertyBool.h
- OpenSim/Common/PropertyBool.cpp
