Regina Calculation Engine
|
Stores a calculable property of an object. More...
#include <utilities/nproperty.h>
Public Types | |
typedef Storage< T >::InitType | InitType |
The type by which new values for the underlying property are passed. More... | |
typedef Storage< T >::QueryType | QueryType |
The type by which the property value is returned to the user. More... | |
Public Member Functions | |
NProperty () | |
Constructor. More... | |
QueryType | value () const |
Returns the current value of this property. More... | |
QueryType | operator= (InitType newValue) |
Assigns a new value to this property. More... | |
const NProperty< T, Storage > & | operator= (const NProperty< T, Storage > &newValue) |
Copies the given property into this property. More... | |
bool | known () const |
Returns whether or not this property is currently marked as known. More... | |
void | clear () |
Marks this property as unknown. More... | |
Stores a calculable property of an object.
The property may be marked as known or unknown, and its value may be set or retrieved.
The template parameter Storage specifies how the property will be internally stored. Storage options range from simple storage by value (see class StoreValue) to more intelligent storage options that include memory management of pointers (see class StoreManagedPtr).
typedef Storage<T>::InitType regina::NProperty< T, Storage >::InitType |
The type by which new values for the underlying property are passed.
typedef Storage<T>::QueryType regina::NProperty< T, Storage >::QueryType |
The type by which the property value is returned to the user.
|
inline |
Constructor.
This property is initially marked as unknown.
|
inlinevirtual |
Marks this property as unknown.
Implements regina::NPropertyBase.
|
inlinevirtual |
Returns whether or not this property is currently marked as known.
Implements regina::NPropertyBase.
|
inline |
Assigns a new value to this property.
The property will be marked as known.
newValue | the new value to assign to this property. |
|
inline |
Copies the given property into this property.
If the given property is marked as known, its value will be copied and this property will also be marked as known. Otherwise this property will be marked as unknown.
newValue | the property to copy into this property. |
|
inline |
Returns the current value of this property.
If this property is marked as unknown then the results are undefined.