OnixS C++ Eurex T7 Market and Reference Data Interface (EMDI, RDI, EOBI) Handlers  7.4.2
API documentation
FieldSet Class Reference

#include <OnixS/Eurex/MarketData/FieldSet.h>

Collaboration diagram for FieldSet:

Public Member Functions

 operator bool () const
 
FieldValueRef get (Tag tag) const
 
Int32 getInt32 (Tag tag) const
 
UInt32 getUInt32 (Tag tag) const
 
Int64 getInt64 (Tag tag) const
 
UInt64 getUInt64 (Tag tag) const
 
Decimal getDecimal (Tag tag) const
 
StringRef getStringRef (Tag tag) const
 
Timestamp getTimestamp (Tag tag, TimestampFormat::Enum=TimestampFormat::YYYYMMDDHHMMSSNsec) const
 
Group getGroup (Tag numberOfInstancesTag) const
 
Group getOptionalGroup (Tag numberOfInstancesTag) const
 
bool hasFlag (Tag tag) const
 
size_t fields (Fields &fields) const
 
void swap (FieldSet &) throw ()
 

Protected Member Functions

 FieldSet ()
 
 FieldSet (const Message *, void *)
 
 FieldSet (const FieldSet &)
 
 ~FieldSet ()
 
FieldSetoperator= (const FieldSet &)
 

Protected Attributes

const Messagecontainer_
 
void * impl_
 

Friends

class Message
 
class GroupInstance
 
class MessageOperator
 

Detailed Description

Encapsulates primary operations over collection of FIX fields like FIX message and repeating group instance are.

Definition at line 66 of file FieldSet.h.

Constructor & Destructor Documentation

FieldSet ( )
protected

Definition at line 71 of file FieldSet.cpp.

FieldSet ( const Message container,
void *  impl 
)
protected

Definition at line 77 of file FieldSet.cpp.

FieldSet ( const FieldSet other)
protected

Definition at line 83 of file FieldSet.cpp.

~FieldSet ( )
protected

Definition at line 89 of file FieldSet.cpp.

Member Function Documentation

size_t fields ( Fields fields) const

Retrieve tags and values of all non-empty fields belonged to the given FieldSet instance.

Parameters
fieldsObject to receive the FieldSet content.
Returns
Number of fields placed to the fields vector.

Definition at line 323 of file FieldSet.cpp.

FieldValueRef get ( Tag  tag) const

Returns reference to a given field value.

Warning
Due to performance considerations, doesn't check whether instance refers to a valid set of fields. Use OnixS::FIX::FieldSet::operator bool() to check whether instance is in valid state.

Definition at line 122 of file FieldSet.cpp.

OnixS::Eurex::MarketData::Decimal getDecimal ( Tag  tag) const

Returns the field value as a decimal number.

Exceptions
std::exceptionif conversion is impossible.
Warning
Due to performance considerations, doesn't check whether instance refers to a valid set of fields. Use OnixS::FIX::FieldSet::operator bool() to check whether instance is in valid state.

Definition at line 191 of file FieldSet.cpp.

Group getGroup ( Tag  numberOfInstancesTag) const

Returns reference to a repeating group if underlying field defines length of repeating group.

Parameters
numberOfInstancesTagTag number of the field that defines the number of instances in this repeating group (the NoXXX field).
Exceptions
std::exceptionif no repeating group is associated with given field (tag).
Warning
Returned instance remains valid until field is modified via any of OnixS::FIX::FieldSet::set members.

Definition at line 281 of file FieldSet.cpp.

Int32 getInt32 ( Tag  tag) const

Returns field value as an OnixS::FIX::Int32 value.

Exceptions
std::exceptionif conversion is impossible.
Warning
Due to performance considerations, doesn't check whether instance refers to a valid set of fields. Use OnixS::FIX::FieldSet::operator bool() to check whether instance is in valid state.

Definition at line 135 of file FieldSet.cpp.

Int64 getInt64 ( Tag  tag) const

Returns field value as an OnixS::FIX::Int64 value.

Exceptions
std::exceptionif conversion is impossible.
Warning
Due to performance considerations, doesn't check whether instance refers to a valid set of fields. Use OnixS::FIX::FieldSet::operator bool() to check whether instance is in valid state.

Definition at line 163 of file FieldSet.cpp.

Group getOptionalGroup ( Tag  numberOfInstancesTag) const

Returns reference to a repeating group if underlying field defines length of repeating group.

Parameters
numberOfInstancesTagTag number of the field that defines the number of instances in this repeating group (the NoXXX field).
Warning
Returned instance remains valid until field is modified via any of OnixS::FIX::FieldSet::set members.

Definition at line 295 of file FieldSet.cpp.

OnixS::Eurex::MarketData::StringRef getStringRef ( Tag  tag) const

Returns reference to a read-only text chain.

Exceptions
std::exceptionif conversion is impossible.
Warning
Due to performance considerations, doesn't check whether instance refers to a valid set of fields. Use OnixS::FIX::FieldSet::operator bool() to check whether instance is in valid state.

Definition at line 208 of file FieldSet.cpp.

Timestamp getTimestamp ( Tag  tag,
TimestampFormat::Enum  format = TimestampFormat::YYYYMMDDHHMMSSNsec 
) const

Returns the field value as timestamp of requested format.

Exceptions
std::exceptionif conversion is impossible.
Warning
Due to performance considerations, doesn't check whether instance refers to a valid set of fields. Use OnixS::FIX::FieldSet::operator bool() to check whether instance is in valid state.

Definition at line 225 of file FieldSet.cpp.

UInt32 getUInt32 ( Tag  tag) const

Returns field value as an OnixS::FIX::UInt32 value.

Exceptions
std::exceptionif conversion is impossible.
Warning
Due to performance considerations, doesn't check whether instance refers to a valid set of fields. Use OnixS::FIX::FieldSet::operator bool() to check whether instance is in valid state.

Definition at line 149 of file FieldSet.cpp.

UInt64 getUInt64 ( Tag  tag) const

Returns field value as an OnixS::FIX::UInt64 value.

Exceptions
std::exceptionif conversion is impossible.
Warning
Due to performance considerations, doesn't check whether instance refers to a valid set of fields. Use OnixS::FIX::FieldSet::operator bool() to check whether instance is in valid state.

Definition at line 177 of file FieldSet.cpp.

bool hasFlag ( Tag  tag) const

Returns true if the given flag is present and it equals to "Y", otherwise false.

Warning
Due to performance considerations, doesn't check whether instance refers to a valid set of fields. Use OnixS::FIX::FieldSet::operator bool() to check whether instance is in valid state.

Definition at line 309 of file FieldSet.cpp.

operator bool ( ) const

Indicates whether instance refers to a valid set of fields.

If given instance doesn't refer to a valid fields set, none of other members must be used.

Definition at line 114 of file FieldSet.cpp.

FieldSet & operator= ( const FieldSet other)
protected

Definition at line 101 of file FieldSet.cpp.

void swap ( FieldSet other)
throw (
)

Definition at line 94 of file FieldSet.cpp.

Friends And Related Function Documentation

friend class GroupInstance
friend

Definition at line 222 of file FieldSet.h.

friend class Message
friend

Definition at line 221 of file FieldSet.h.

friend class MessageOperator
friend

Definition at line 223 of file FieldSet.h.

Member Data Documentation

const Message* container_
protected

Definition at line 201 of file FieldSet.h.

void* impl_
protected

Definition at line 204 of file FieldSet.h.


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