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

Encapsulates operations over a FIX Message. More...

Public Member Functions

 Message ()
 Initializes message in 'unconstructed' state.
 
 Message (const Message &other)
 Initializes instance as deep copy of other one. More...
 
 ~Message ()
 Disposes all internal data structures. More...
 
FieldValueRef type () const
 Returns the message type (MsgType(35) field value).
 
SequenceNumber sequenceNumber () const
 Returns the MsgSeqNum field from CME binary packet header. More...
 
Timestamp sendingTime () const
 Returns the Sending Time field from CME binary packet header. More...
 
const TimestampreceiveTime () const
 Indicates time when packet holding given message was received. More...
 
std::string toString (char delimiter=0x1) const
 Returns the string representation of the message using the given delimiter and additional control flags. More...
 
void toString (std::string &str, char delimiter=0x1) const
 Appends string representation of the message using the given delimiter and additional control flags. More...
 
Messageoperator= (const Message &)
 
- Public Member Functions inherited from FieldSet
 operator bool () const
 Indicates whether instance refers to a valid set of fields. More...
 
FieldValueRef get (Tag tag) const
 Provides access to field value using field tag. More...
 
char getChar (Tag tag) const
 Returns field value as a char value. More...
 
Int32 getInt32 (Tag tag) const
 Returns field value as an Int32 value. More...
 
UInt32 getUInt32 (Tag tag) const
 Returns field value as an UInt32 value. More...
 
Int64 getInt64 (Tag tag) const
 Returns field value as an Int64 value. More...
 
UInt64 getUInt64 (Tag tag) const
 Returns field value as an UInt64 value. More...
 
Decimal getDecimal (Tag tag) const
 Returns the field value as a decimal number. More...
 
StringRef getStringRef (Tag tag) const
 Returns reference to a read-only text chain. More...
 
Timestamp getTimestamp (Tag tag, SinceEpochUnit unit) const
 Returns the field value as timestamp of requested format. More...
 
Group getGroup (Tag tag) const
 Returns reference to a repeating group if underlying field defines length of repeating group. More...
 
Group getOptionalGroup (Tag tag, bool strict=true) const
 Returns reference to a repeating group if underlying field defines length of repeating group. More...
 
bool hasFlag (Tag tag) const
 Returns true if the given flag is present and it equals to "Y", otherwise false. More...
 
bool contain (Tag tag) const
 Checks the presence of a field This method should be used if the actual field value is NOT of interest - otherwise field lookup operation will be done twice. More...
 

Friends

class MessageOperator
 

Additional Inherited Members

- Protected Member Functions inherited from FieldSet
 FieldSet (const Message *, const void *)
 
 FieldSet (const FieldSet &)
 
FieldSetoperator= (const FieldSet &)
 
- Protected Attributes inherited from FieldSet
const void * impl_
 
const Messagecontainer_
 

Detailed Description

Encapsulates operations over a FIX Message.

Message supports 'unconstructed' state which can be treated as pointer in null state. However, in contrast to Group and GroupInstance classes it does NOT represent light-weight wrapper over internal structures. In fact, it holds all the data which is fully copied on assignment or copy construction and disposed at instance destruction.

FIX field related operations now available via FieldSet class from which Message class is now derived.

Constructor & Destructor Documentation

Message ( const Message other)

Initializes instance as deep copy of other one.

Parameters
otherMessage to be copied from.
~Message ( )

Disposes all internal data structures.

Warning
Once instance is destructed, all instances of Group and GroupInstance classes obtained from this instance must not be used any more.

Member Function Documentation

const Timestamp& receiveTime ( ) const

Indicates time when packet holding given message was received.

Timestamp sendingTime ( ) const

Returns the Sending Time field from CME binary packet header.

Please note: this field is attributed to packet, not message. Packet can contain several messages, so they will share same sending time.

SequenceNumber sequenceNumber ( ) const

Returns the MsgSeqNum field from CME binary packet header.

Please note: this field is attributed to packet, not message. Packet can contain several messages, so they will share same sequence number.

std::string toString ( char  delimiter = 0x1) const
inline

Returns the string representation of the message using the given delimiter and additional control flags.

Parameters
delimiterDefines field delimiter to be used.
void toString ( std::string &  str,
char  delimiter = 0x1 
) const

Appends string representation of the message using the given delimiter and additional control flags.

Parameters
strString to which presentation is appended.
delimiterDefines field delimiter to be used.