GPL_Value

gpl

1998 12-05

CLASS

SYNOPSIS

PARENTS

CONSTRUCTOR

GPL_Value(void)
Construct as type GPL_VALUETYPE_NULL.
GPL_Value(const GPL_Value & v)
Construct with same type and value as v.
GPL_Value(GPL_Real r)
Construct as type GPL_VALUETYPE_REAL with value r and precision 0.0.
GPL_Value(GPL_Real r, GPL_Real p)
Construct as type GPL_VALUETYPE_REAL with value r and precision p.
GPL_Value(GPL_String s)
Construct as type GPL_VALUETYPE_STRING and set string to contents of s.
GPL_Value(GPL_Block b)
Construct as type GPL_VALUETYPE_BLOCK and set block to contents of b.
GPL_Value(const GPL_Message &m)
Construct as type GPL_VALUETYPE_MESSAGE and set message to contents of m.

OPERATORS

GPL_Value & operator=(const GPL_Value & v)
Set to same type and value as v.
GPL_Boolean operator==(const GPL_Value & v) const
If Compare(emv) returns zero return TRUE, otherwise return FALSE.

MEMBER FUNCTIONS

GPL_ValueType GetType(void) const
Return the type.
GPL_Boolean IsNull(void) const
Returns TRUE if the type of the value is GPL_VALUE_NULL; FALSE otherwise.
GPL_Integer GetInteger(void) const
Returns the data for integer and real values. For string values, returns the data converted into an integer as per atol(). For byte-block values, returns the number of bytes in the block. For null values, returns 0.
GPL_Real GetReal(void) const
Returns the data for integer and real values. For string values, returns the data converted into a real as per atof(). For byte-block values, returns the number of bytes in the block. For null values, returns 0.0.
GPL_Real GetPrecision(void) const
Returns the precision for a GPL_VALUE_REAL value. Otherwise return 0.0.
GPL_String GetString(void) const
For integer and real values, returns the data converted into a string as per sprintf(). Returns the data for string values. For byte-block values, returns the data treated as a string. For null values, returns the null string.
GPL_Address GetBlock(unsigned long & l) const
For integer, real, and null values, returns the well-known bad address, GPL_BAD_ADDRESS. For string and byte-block values, returns the data. Upon return, l contains the number of bytes in the block for string and byte-block values, and 0 for all others.
void GetBlock(GPL_Block &b) const
For integer, real, and null values, returns the well-known bad address, GPL_BAD_ADDRESS. For string and byte-block values, returns the data.
GPL_Message &GetMessage(void) const
For message values return the message, otherwise return a blank message.
virtual long Compare(const GPL_Value & v) const
If the types and values are the same return zero, otherwise return non-zero.
void SetNull(void)
Set as type GPL_VALUETYPE_NULL.
void SetInteger(const GPL_Integer i)
Set as type GPL_VALUETYPE_INTEGER with value i.
void SetReal(const GPL_Real r)
Set as type GPL_VALUETYPE_REAL with value r.
void SetReal(const GPL_Real r, const GPL_Real p)
Set as type GPL_VALUETYPE_REAL with value r and precision p.
void SetPrecision(const GPL_Real p)
Set precision to p.
void SetString(const GPL_String & s)
Set as type GPL_VALUETYPE_STRING with the content of s.
void SetBlock(GPL_Address b, const unsigned long l)
Set as type GPL_VALUETYPE_BLOCK with the content of b.
void SetBlock(const GPL_Block &b)
Set as type GPL_VALUETYPE_BLOCK with the content of b.
void SetMessage(const GPL_Message &m)
Set as type GPL_VALUETYPE_MESSAGE with the content of m.