OnixS CME Drop Copy Handler for C++  5.3.0.0
Public Member Functions | Friends | List of all members
FieldValueRef Class Reference

Reference to a read-only FIX field value. More...

Public Member Functions

 FieldValueRef ()
 Uninitialized value.
 
 FieldValueRef (const FieldValueRef &)
 Shallow copy from another one.
 
 operator bool () const
 Indicated whether the instance refers to a valid value. More...
 
 operator std::string () const
 Return string presentation of the value being referenced. More...
 
bool operator== (const FieldValueRef &) const
 Compares with another instance for equality.
 
bool operator!= (const FieldValueRef &) const
 Compares with another instance for inequality.
 
bool operator== (const StringRef &) const
 Compares string presentation for equality with given text reference. More...
 
bool operator!= (const StringRef &) const
 Compares string presentation for equality with given text reference. More...
 
bool toNumber (Int32 &) const
 Converts field value into a whole number. More...
 
bool toNumber (UInt32 &) const
 Converts field value into a whole number. More...
 
bool toNumber (Int64 &) const
 Converts field value into a whole number. More...
 
bool toNumber (UInt64 &) const
 Converts field value into a whole number. More...
 
bool toNumber (Decimal &) const
 Converts field value into a whole number. More...
 
bool toTimestamp (Timestamp &, SinceEpochUnit) const
 Converts field value into Timestamp. More...
 
bool toStringRef (StringRef &) const
 If value represents text, returns reference to it. More...
 
bool toChar (char &) const
 If value represent one-char text, copies it into given variable. More...
 
bool toGroup (Group &) const
 If repeating group is associated with field, allows to get instance of it. More...
 
void toString (std::string &) const
 Appends copy of referenced value text presentation to the std::string. More...
 
std::string toString () const
 Return string presentation of field value.
 
FieldValueRefoperator= (const FieldValueRef &)
 Updates instance to refer to another field value. More...
 

Friends

class MessageOperator
 

Detailed Description

Reference to a read-only FIX field value.

Reference may refers to a valid field value or to nothing. 'operator bool()' is exposed to check whether instance refers to existent field value.

Member Function Documentation

operator bool ( ) const

Indicated whether the instance refers to a valid value.

operator std::string ( ) const
inline

Return string presentation of the value being referenced.

bool operator!= ( const StringRef ) const

Compares string presentation for equality with given text reference.

FieldValueRef& operator= ( const FieldValueRef )

Updates instance to refer to another field value.

Warning
Does NOT perform deep copy of field values. Just updates reference to point to value of other field.
bool operator== ( const StringRef ) const

Compares string presentation for equality with given text reference.

bool toChar ( char &  ) const

If value represent one-char text, copies it into given variable.

Returns
false if value referenced by instance can't be converted into value of target type.
Note
conversion of instance referencing to nothing always fails.
bool toGroup ( Group ) const

If repeating group is associated with field, allows to get instance of it.

Returns
false if no group is associated with field.
bool toNumber ( Int32 &  ) const

Converts field value into a whole number.

Returns
false if value referenced by instance can't be converted into value of target type.
Note
conversion of instance referencing to nothing always fails.
bool toNumber ( UInt32 &  ) const

Converts field value into a whole number.

Returns
false if value referenced by instance can't be converted into value of target type.
Note
conversion of instance referencing to nothing always fails.
bool toNumber ( Int64 &  ) const

Converts field value into a whole number.

Returns
false if value referenced by instance can't be converted into value of target type.
Note
conversion of instance referencing to nothing always fails.
bool toNumber ( UInt64 &  ) const

Converts field value into a whole number.

Returns
false if value referenced by instance can't be converted into value of target type.
Note
conversion of instance referencing to nothing always fails.
bool toNumber ( Decimal ) const

Converts field value into a whole number.

Returns
false if value referenced by instance can't be converted into value of target type.
Note
conversion of instance referencing to nothing always fails.
void toString ( std::string &  ) const

Appends copy of referenced value text presentation to the std::string.

bool toStringRef ( StringRef ) const

If value represents text, returns reference to it.

Returns
false if value referenced by instance can't be converted into value of target type. If value being referenced is not of string type (like number or datetime), conversion fails.
Note
conversion of instance referencing to nothing always fails.
bool toTimestamp ( Timestamp ,
SinceEpochUnit   
) const

Converts field value into Timestamp.

Returns
false if value referenced by instance can't be converted into value of target type.
Note
conversion of instance referencing to nothing always fails.