FieldSet Class Reference

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

List of all members.

Public Member Functions
	operator bool () const
	Indicates whether instance refers to a valid set of fields.
FieldValueRef	get (Tag tag) const
	Returns reference to a given field value.
Int32	getInt32 (Tag tag) const
	Returns field value as an OnixS::FIX::Int32 value.
UInt32	getUInt32 (Tag tag) const
	Returns field value as an OnixS::FIX::UInt32 value.
Int64	getInt64 (Tag tag) const
	Returns field value as an OnixS::FIX::Int64 value.
UInt64	getUInt64 (Tag tag) const
	Returns field value as an OnixS::FIX::UInt64 value.
Decimal	getDecimal (Tag tag) const
	Returns the field value as a decimal number.
StringRef	getStringRef (Tag tag) const
	Returns reference to a read-only text chain.
Timestamp	getTimestamp (Tag tag, TimestampFormat::Enum=TimestampFormat::YYYYMMDDHHMMSSNsec) const
	Returns the field value as timestamp of requested format.
Group	getGroup (Tag numberOfInstancesTag) const
	Returns reference to a repeating group if underlying field defines length of repeating group.
Group	getOptionalGroup (Tag numberOfInstancesTag) const
	Returns reference to a repeating group if underlying field defines length of repeating group.
bool	hasFlag (Tag tag) const
	Returns true if the given flag is present and it equals to "Y", otherwise false.
template<typename Enumeration >
Enumeration::Enum	getIntEnumFieldValue (Tag tag) const
template<typename Enumeration >
Enumeration::Enum	getCharEnumFieldValue (Tag tag) const
Protected Member Functions
	FieldSet (const Message *, void *)
	FieldSet (const FieldSet &)
FieldSet &	operator= (const FieldSet &)
Protected Attributes
void *	impl_
const Message *	container_
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.

---

Member Function Documentation

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.

Decimal getDecimal

(

Tag

tag

)

const

Returns the field value as a decimal number.

Exceptions:

std::exception

if 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.

Group getGroup

(

Tag

numberOfInstancesTag

)

const

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

Parameters:

numberOfInstancesTag

Tag number of the field that defines the number of instances in this repeating group (the NoXXX field).

Exceptions:

std::exception

if 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.

Int32 getInt32

(

Tag

tag

)

const

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

Exceptions:

std::exception

if 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.

Int64 getInt64

(

Tag

tag

)

const

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

Exceptions:

std::exception

if 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.

Group getOptionalGroup

(

Tag

numberOfInstancesTag

)

const

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

Parameters:

numberOfInstancesTag

Tag 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.

StringRef getStringRef

(

Tag

tag

)

const

Returns reference to a read-only text chain.

Exceptions:

std::exception

if 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.

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

Returns the field value as timestamp of requested format.

Exceptions:

std::exception

if 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.

UInt32 getUInt32

(

Tag

tag

)

const

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

Exceptions:

std::exception

if 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.

UInt64 getUInt64

(

Tag

tag

)

const

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

Exceptions:

std::exception

if 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.

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.

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.