rpt_value_reference Class Reference
#include <ref.h>
Public Member Functions | |
| virtual | ~rpt_value_reference () |
| rpt_value::pointer | get () const |
| void | set (const rpt_value::pointer &value) |
Static Public Member Functions | |
| static rpt_value::pointer | create (const rpt_value::pointer &value) |
Protected Member Functions | |
| rpt_value::pointer | integerize_or_null () const |
| rpt_value::pointer | realize_or_null () const |
| rpt_value::pointer | arithmetic_or_null () const |
| rpt_value::pointer | stringize_or_null () const |
| rpt_value::pointer | booleanize_or_null () const |
| rpt_value::pointer | lookup (const rpt_value::pointer &rhs, bool lvalue) const |
| rpt_value::pointer | keys () const |
| rpt_value::pointer | count () const |
| const char * | type_of () const |
| const char * | name () const |
Private Member Functions | |
| rpt_value_reference (const rpt_value::pointer &value) | |
| rpt_value_reference () | |
| rpt_value_reference (const rpt_value_reference &) | |
| rpt_value_reference & | operator= (const rpt_value_reference &) |
Private Attributes | |
| rpt_value::pointer | value |
Detailed Description
The rpt_value_reference class is used to represent a proxy for another value. This is how variables are implemented in the report generator.Definition at line 30 of file ref.h.
Constructor & Destructor Documentation
| virtual rpt_value_reference::~rpt_value_reference | ( | ) | [virtual] |
The destructor.
| rpt_value_reference::rpt_value_reference | ( | const rpt_value::pointer & | value | ) | [private] |
The constructor. It is private on purpose, use the "create" class method instead.
| rpt_value_reference::rpt_value_reference | ( | ) | [private] |
The default constructor. Do not use.
| rpt_value_reference::rpt_value_reference | ( | const rpt_value_reference & | ) | [private] |
The copy constructor. Do not use.
Member Function Documentation
| static rpt_value::pointer rpt_value_reference::create | ( | const rpt_value::pointer & | value | ) | [static] |
The create class method is used to create new dynamically allocated instance of this class.
| rpt_value::pointer rpt_value_reference::get | ( | ) | const |
The get method may be used to get the value being referenced.
| void rpt_value_reference::set | ( | const rpt_value::pointer & | value | ) |
The set method may be used to set the value being referenced. Only use this if you are implementing a report generator variable.
- Parameters:
-
value The new value for the variable.
| rpt_value::pointer rpt_value_reference::integerize_or_null | ( | ) | const [protected, virtual] |
The integerize_or_null method is used to convert a value to an integer, if possible, or return NULL if it is not possible. This NULL is used by the integerize class method to return the unchanged value if no conversion is possible.
Reimplemented from rpt_value.
| rpt_value::pointer rpt_value_reference::realize_or_null | ( | ) | const [protected, virtual] |
The realize_or_null method is used to convert a value to an real, if possible, or return NULL if it is not possible. This NULL is used by the realize class method to return the unchanged value if no conversion is possible.
Reimplemented from rpt_value.
| rpt_value::pointer rpt_value_reference::arithmetic_or_null | ( | ) | const [protected, virtual] |
The arithmetic_or_null method is used to convert a value to an arithmetic type (real or integer), if possible, or return NULL if it is not possible. This NULL is used by the integerize class method to return the unchanged value if no conversion is possible.
Reimplemented from rpt_value.
| rpt_value::pointer rpt_value_reference::stringize_or_null | ( | ) | const [protected, virtual] |
The stringize_or_null method is used to convert a value to a string, if possible, or return NULL if it is not possible. This NULL is used by the stringize class method to return the unchanged value if no conversion is possible.
Reimplemented from rpt_value.
| rpt_value::pointer rpt_value_reference::booleanize_or_null | ( | ) | const [protected, virtual] |
The booleanize_or_null method is used to convert a value to a boolean, if possible, or return NULL if it is not possible. This NULL is used by the booleanize class method to return the unchanged value if no conversion is possible.
Reimplemented from rpt_value.
| rpt_value::pointer rpt_value_reference::lookup | ( | const rpt_value::pointer & | rhs, | |
| bool | lvalue | |||
| ) | const [protected, virtual] |
The lookup method is used to index an associate array, or locate a member within a struct.
- Parameters:
-
rhs The member name, or array index lvalue The result is to be used of an l-value
Reimplemented from rpt_value.
| rpt_value::pointer rpt_value_reference::keys | ( | ) | const [protected, virtual] |
The keys method is used to obtain a list of keys of an associative array.
Reimplemented from rpt_value.
| rpt_value::pointer rpt_value_reference::count | ( | ) | const [protected, virtual] |
The count method is used to count the number of elements of an associative array.
Reimplemented from rpt_value.
| const char* rpt_value_reference::type_of | ( | ) | const [protected, virtual] |
The type_of method is used to obtain the name of the type of the value. It differs from the name method in that it resolves references and deferred values.
Reimplemented from rpt_value.
| const char* rpt_value_reference::name | ( | ) | const [protected, virtual] |
The name method is used to obtain the name of the type of the value.
Implements rpt_value.
| rpt_value_reference& rpt_value_reference::operator= | ( | const rpt_value_reference & | ) | [private] |
The assignment operator. Do not use.
Field Documentation
rpt_value::pointer rpt_value_reference::value [private] |
The documentation for this class was generated from the following file:
- libaegis/aer/value/ref.h
