OnixS CME Drop Copy Handler C++ library  5.6.0
API documentation
FieldValueRef Class Reference

#include <OnixS/CME/DropCopy/Messaging.h>

Public Member Functions

 FieldValueRef ()
 
 FieldValueRef (const FieldValueRef &)
 
 operator bool () const
 
 operator std::string () const
 
bool operator== (const FieldValueRef &) const
 
bool operator!= (const FieldValueRef &) const
 
bool operator== (const StringRef &) const
 
bool operator!= (const StringRef &) const
 
bool toNumber (Int32 &) const
 
bool toNumber (UInt32 &) const
 
bool toNumber (Int64 &) const
 
bool toNumber (UInt64 &) const
 
bool toNumber (Decimal &) const
 
bool toTimestamp (Timestamp &, SinceEpochUnit) const
 
bool toStringRef (StringRef &) const
 
bool toChar (char &) const
 
bool toGroup (Group &) const
 
void toString (std::string &) const
 
std::string toString () const
 
FieldValueRefoperator= (const FieldValueRef &)
 

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.

Definition at line 38 of file Messaging.h.

Constructor & Destructor Documentation

Uninitialized value.

Shallow copy from another one.

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.

Definition at line 171 of file Messaging.h.

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.

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 FieldValueRef ) const

Compares with another instance for equality.

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.

std::string toString ( ) const
inline

Return string presentation of field value.

Definition at line 178 of file Messaging.h.

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.

Friends And Related Function Documentation

friend class MessageOperator
friend

Definition at line 163 of file Messaging.h.


The documentation for this class was generated from the following file: