#include <props.hxx>
Inheritance diagram for SGRawValue< T >:
Public Member Functions | |
| SGRawValue () | |
| Constructor. | |
| virtual | ~SGRawValue () |
| Destructor. | |
| virtual T | getValue () const=0 |
| Return the underlying value. | |
| virtual bool | setValue (T value)=0 |
| Assign a new underlying value. | |
| virtual SGRawValue * | clone () const=0 |
| Create a new deep copy of this raw value. | |
Static Public Attributes | |
| static const T | DefaultValue |
| The default underlying value for this type. | |
The property manager is implemented in two layers. The SGPropertyNode is the highest and most abstract layer, representing an LValue/RValue pair: it records the position of the property in the property tree and contains facilities for navigation to other nodes. It is guaranteed to be persistent: the SGPropertyNode will not change during a session, even if the property is bound and unbound multiple times.
When the property value is not managed internally in the SGPropertyNode, the SGPropertyNode will contain a reference to an SGRawValue (this class), which provides an abstract way to get, set, and clone the underlying value. The SGRawValue may change frequently during a session as a value is retyped or bound and unbound to various data source, but the abstract SGPropertyNode layer insulates the application from those changes. The raw value contains no facilities for data binding or for type conversion: it is simply the abstraction of a primitive data type (or a compound data type, in the case of a string).
The SGPropertyNode class always keeps a *copy* of a raw value, not the original one passed to it; if you override a derived class but do not replace the clone method, strange things will happen.
All derived SGRawValue classes must implement getValue, setValue, and clone for the appropriate type.
Definition at line 146 of file props.hxx.
| SGRawValue< T >::SGRawValue | ( | ) | [inline] |
| virtual T SGRawValue< T >::getValue | ( | ) | const [pure virtual] |
Return the underlying value.
Implemented in SGRawValuePointer< T >, SGRawValueFunctions< T >, SGRawValueFunctionsIndexed< T >, SGRawValueMethods< C, T >, and SGRawValueMethodsIndexed< C, T >.
| virtual bool SGRawValue< T >::setValue | ( | T | value | ) | [pure virtual] |
Assign a new underlying value.
If the new value cannot be set (because this is a read-only raw value, or because the new value is not acceptable for some reason) this method returns false and leaves the original value unchanged.
| value | The actual value for the property. |
Implemented in SGRawValuePointer< T >, SGRawValueFunctions< T >, SGRawValueFunctionsIndexed< T >, SGRawValueMethods< C, T >, and SGRawValueMethodsIndexed< C, T >.
| virtual SGRawValue* SGRawValue< T >::clone | ( | ) | const [pure virtual] |
Create a new deep copy of this raw value.
The copy will contain its own version of the underlying value as well.
Implemented in SGRawValuePointer< T >, SGRawValueFunctions< T >, SGRawValueFunctionsIndexed< T >, SGRawValueMethods< C, T >, and SGRawValueMethodsIndexed< C, T >.
Referenced by SGPropertyNode::SGPropertyNode(), and SGPropertyNode::tie().
const T SGRawValue< T >::DefaultValue [static] |
The default underlying value for this type.
Every raw value has a default; the default is false for a boolean, 0 for the various numeric values, and "" for a string. If additional types of raw values are added in the future, they may need different kinds of default values (such as epoch for a date type). The default value is used when creating new values.
1.5.1