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