FieldSet Struct Reference

#include <OnixS/CME/iLink3/messaging/TagBased/Message.h>

Public Member Functions
	operator bool () const noexcept
FieldSet &	reset () noexcept
Field	field (Tag tag) const noexcept
FieldSet &	setField (Tag tag, const Field &field)
FieldSet &	resetField (Tag tag)
Field	operator[] (Tag tag) const noexcept
bool	contain (Tag tag) const noexcept
Char	getChar (Tag tag) const
Int64	getInt64 (Tag tag) const
UInt64	getUInt64 (Tag tag) const
Int32	getInt32 (Tag tag) const
UInt32	getUInt32 (Tag tag) const
Int16	getInt16 (Tag tag) const
UInt16	getUInt16 (Tag tag) const
Int8	getInt8 (Tag tag) const
UInt8	getUInt8 (Tag tag) const
Decimal	getDecimal (Tag tag) const
StrRef	getStringRef (Tag tag) const
Timestamp	getTimestamp (Tag tag) const
MaturityMonthYear	getMaturityMonthYear (Tag tag) const
template<typename Enumeration >
Enumeration::Enum	getEnumeration (Tag tag) const
template<typename BitSet >
BitSet	getBitSet (Tag tag) const
FieldSet &	set (Tag tag, const Field &field)
template<typename BitSet >
FieldSet &	set (Tag tag, BitSet value, typename BitSet::Bits *=nullptr)
FieldSet &	set (Tag tag, Char value)
FieldSet &	set (Tag tag, UInt64 value)
FieldSet &	set (Tag tag, Int64 value)
FieldSet &	set (Tag tag, UInt32 value)
FieldSet &	set (Tag tag, Int32 value)
FieldSet &	set (Tag tag, UInt16 value)
FieldSet &	set (Tag tag, Int16 value)
FieldSet &	set (Tag tag, UInt8 value)
FieldSet &	set (Tag tag, Int8 value)
FieldSet &	set (Tag tag, const Decimal &value)
FieldSet &	set (Tag tag, StrRef value)
FieldSet &	set (Tag tag, Timestamp value)
FieldSet &	set (Tag tag, const MaturityMonthYear &value)

Protected Member Functions
	~FieldSet ()=default
	FieldSet (BinaryBlockBase &binary, const FieldAccessor *accessor) noexcept
const FieldAccessor *	accessor () const noexcept
void	setAccessor (const FieldAccessor *obj) noexcept

Detailed Description

Definition at line 53 of file Message.h.

Constructor & Destructor Documentation

~FieldSet ( )

protecteddefault

FieldSet ( BinaryBlockBase &  binary, const FieldAccessor *  accessor  )

inlineprotectednoexcept

Initializes the instance over the binary data.

Definition at line 478 of file Message.h.

Member Function Documentation

const FieldAccessor* accessor ( ) const

inlineprotectednoexcept

Returns

FieldAccessor.

Definition at line 488 of file Message.h.

bool contain ( Tag  tag ) const

noexcept

Returns

true if the field-set contains the field with the given tag, otherwise - false.

Warning

Does not check whether the instance refers to a valid set of fields. Use operator bool() to check whether the instance is in a valid state.

Field field ( Tag  tag ) const

inlinenoexcept

Returns

Field by its tag.

Warning

Does not check whether the instance refers to a valid set of fields. Use operator bool() to check whether the instance is in a valid state.

Definition at line 80 of file Message.h.

BitSet getBitSet ( Tag  tag ) const

inline

Returns

the field value as a set.

Exceptions

std::runtime_error

if conversion is impossible or the value does not exist.

Warning

Does not check whether the instance refers to a valid set of fields. Use operator bool() to check whether the instance is in a valid state.

Definition at line 312 of file Message.h.

Char getChar

(

Tag

tag

)

const

Returns

field value as an Char value.

Exceptions

std::runtime_error

if conversion is impossible or the value does not exist.

Warning

Does not check whether the instance refers to a valid set of fields. Use operator bool() to check whether the instance is in a valid state.

Decimal getDecimal

(

Tag

tag

)

const

Returns

the field value as a Decimal number.

Exceptions

std::runtime_error

if conversion is impossible or the value does not exist.

Warning

Does not check whether the instance refers to a valid set of fields. Use operator bool() to check whether the instance is in a valid state.

Enumeration::Enum getEnumeration ( Tag  tag ) const

inline

Returns

the field value as an enumeration.

Exceptions

std::runtime_error

if conversion is impossible or the value does not exist.

Warning

Does not check whether the instance refers to a valid set of fields. Use operator bool() to check whether the instance is in a valid state.

Definition at line 297 of file Message.h.

Int16 getInt16

(

Tag

tag

)

const

Returns

field value as an Int16 value.

Exceptions

std::runtime_error

if conversion is impossible or the value does not exist.

Warning

Does not check whether the instance refers to a valid set of fields. Use operator bool() to check whether the instance is in a valid state.

Int32 getInt32

(

Tag

tag

)

const

Returns

field value as an Int32 value.

Exceptions

std::runtime_error

if conversion is impossible or the value does not exist.

Warning

Does not check whether the instance refers to a valid set of fields. Use operator bool() to check whether the instance is in a valid state.

Int64 getInt64

(

Tag

tag

)

const

Returns

field value as an Int64 value.

Exceptions

std::runtime_error

if conversion is impossible or the value does not exist.

Warning

Does not check whether the instance refers to a valid set of fields. Use operator bool() to check whether the instance is in a valid state.

Int8 getInt8

(

Tag

tag

)

const

Returns

field value as an Int8 value.

Exceptions

std::runtime_error

if conversion is impossible or the value does not exist.

Warning

Does not check whether the instance refers to a valid set of fields. Use operator bool() to check whether the instance is in a valid state.

MaturityMonthYear getMaturityMonthYear

(

Tag

tag

)

const

Returns

the field value as a MaturityMonthYear.

Exceptions

std::runtime_error

if conversion is impossible or the value does not exist.

Warning

Does not check whether the instance refers to a valid set of fields. Use operator bool() to check whether the instance is in a valid state.

StrRef getStringRef

(

Tag

tag

)

const

Returns

reference to a read-only text chain.

Exceptions

std::runtime_error

if conversion is impossible or the value does not exist.

Warning

Does not check whether the instance refers to a valid set of fields. Use operator bool() to check whether the instance is in a valid state.

Timestamp getTimestamp

(

Tag

tag

)

const

Returns

the field value as a timestamp

Exceptions

std::runtime_error

if conversion is impossible or the value does not exist.

Warning

Does not check whether the instance refers to a valid set of fields. Use operator bool() to check whether the instance is in a valid state.

UInt16 getUInt16

(

Tag

tag

)

const

Returns

field value as an UInt16 value.

Exceptions

std::runtime_error

if conversion is impossible or the value does not exist.

Warning

Does not check whether the instance refers to a valid set of fields. Use operator bool() to check whether the instance is in a valid state.

UInt32 getUInt32

(

Tag

tag

)

const

Returns

field value as an UInt32 value.

Exceptions

std::runtime_error

if conversion is impossible or the value does not exist.

Warning

Does not check whether the instance refers to a valid set of fields. Use operator bool() to check whether the instance is in a valid state.

UInt64 getUInt64

(

Tag

tag

)

const

Returns

field value as an UInt64 value.

Exceptions

std::runtime_error

if conversion is impossible or the value does not exist.

Warning

Does not check whether the instance refers to a valid set of fields. Use operator bool() to check whether the instance is in a valid state.

UInt8 getUInt8

(

Tag

tag

)

const

Returns

field value as an UInt8 value.

Exceptions

std::runtime_error

if conversion is impossible or the value does not exist.

Warning

Does not check whether the instance refers to a valid set of fields. Use operator bool() to check whether the instance is in a valid state.

operator bool ( ) const

inlineexplicitnoexcept

Returns

true if the instance refers to a valid repeating group entry, otherwise - false.

Definition at line 56 of file Message.h.

Field operator[] ( Tag  tag ) const

inlinenoexcept

Returns

field by its tag.

If the source does not contain any field with the given tag, the returned instance represents a null field.

Warning

Does not check whether the instance refers to a valid set of fields. Use operator bool() to check whether the instance is in a valid state.

Definition at line 130 of file Message.h.

FieldSet& reset ( )

inlinenoexcept

Resets all variable-length and optional fields.

Warning

Does not check whether the instance refers to a valid set of fields. Use operator bool() to check whether the instance is in a valid state.

Definition at line 67 of file Message.h.

FieldSet& resetField ( Tag  tag )

inline

Resets the field by its tag.

Exceptions

std::runtime_error

if or the value is not optional or the value is not allowed.

Warning

Does not check whether the instance refers to a valid set of fields. Use operator bool() to check whether the instance is in a valid state.

Definition at line 111 of file Message.h.

FieldSet& set ( Tag  tag, const Field &  field  )

inline

Assigns a given value.

Exceptions

std::runtime_error

if conversion is impossible or the value is not allowed.

Definition at line 321 of file Message.h.

FieldSet& set ( Tag  tag, BitSet  value, typename BitSet::Bits *  = nullptr  )

inline

Assigns a given value as a set.

Exceptions

std::runtime_error

if conversion is impossible or the value is not allowed.

Definition at line 331 of file Message.h.

FieldSet& set	(	Tag	tag,
		Char	value
	)

Assigns a given value.

Exceptions

std::runtime_error

if conversion is impossible or the value is not allowed.

FieldSet& set	(	Tag	tag,
		UInt64	value
	)

Assigns a given value.

Exceptions

std::runtime_error

if conversion is impossible or the value is not allowed.

Warning

Does not check whether the instance refers to a valid set of fields. Use operator bool() to check whether the instance is in a valid state.

FieldSet& set	(	Tag	tag,
		Int64	value
	)

Assigns a given value.

Exceptions

std::runtime_error

if conversion is impossible or the value is not allowed.

Warning

Does not check whether the instance refers to a valid set of fields. Use operator bool() to check whether the instance is in a valid state.

FieldSet& set	(	Tag	tag,
		UInt32	value
	)

Assigns a given value.

Exceptions

std::runtime_error

if conversion is impossible or the value is not allowed.

Warning

Does not check whether the instance refers to a valid set of fields. Use operator bool() to check whether the instance is in a valid state.

FieldSet& set	(	Tag	tag,
		Int32	value
	)

Assigns a given value.

Exceptions

std::runtime_error

if conversion is impossible or the value is not allowed.

Warning

Does not check whether the instance refers to a valid set of fields. Use operator bool() to check whether the instance is in a valid state.

FieldSet& set	(	Tag	tag,
		UInt16	value
	)

Assigns a given value.

Exceptions

std::runtime_error

if conversion is impossible or the value is not allowed.

Warning

Does not check whether the instance refers to a valid set of fields. Use operator bool() to check whether the instance is in a valid state.

FieldSet& set	(	Tag	tag,
		Int16	value
	)

Assigns a given value.

Exceptions

std::runtime_error

if conversion is impossible or the value is not allowed.

Warning

Does not check whether the instance refers to a valid set of fields. Use operator bool() to check whether the instance is in a valid state.

FieldSet& set	(	Tag	tag,
		UInt8	value
	)

Assigns a given value.

Exceptions

std::runtime_error

if conversion is impossible or the value is not allowed.

Warning

Does not check whether the instance refers to a valid set of fields. Use operator bool() to check whether the instance is in a valid state.

FieldSet& set	(	Tag	tag,
		Int8	value
	)

Assigns a given value.

Exceptions

std::runtime_error

if conversion is impossible or the value is not allowed.

Warning

Does not check whether the instance refers to a valid set of fields. Use operator bool() to check whether the instance is in a valid state.

FieldSet& set	(	Tag	tag,
		const Decimal &	value
	)

Assigns a given value.

Exceptions

std::runtime_error

if conversion is impossible or the value is not allowed.

Warning

Does not check whether the instance refers to a valid set of fields. Use operator bool() to check whether the instance is in a valid state.

FieldSet& set	(	Tag	tag,
		StrRef	value
	)

Assigns a given value.

Exceptions

std::runtime_error

if conversion is impossible or the value is not allowed.

Warning

Does not check whether the instance refers to a valid set of fields. Use operator bool() to check whether the instance is in a valid state.

FieldSet& set	(	Tag	tag,
		Timestamp	value
	)

Assigns a given value.

Exceptions

std::runtime_error

if conversion is impossible or the value is not allowed.

Warning

Does not check whether the instance refers to a valid set of fields. Use operator bool() to check whether the instance is in a valid state.

FieldSet& set	(	Tag	tag,
		const MaturityMonthYear &	value
	)

Assigns a given value.

Exceptions

std::runtime_error

if conversion is impossible or the value is not allowed.

Warning

Does not check whether the instance refers to a valid set of fields. Use operator bool() to check whether the instance is in a valid state.

void setAccessor ( const FieldAccessor *  obj )

inlineprotectednoexcept

Sets the FieldAccessor.

Definition at line 494 of file Message.h.

FieldSet& setField ( Tag  tag, const Field &  field  )

inline

Assigns the field by its tag.

Exceptions

std::runtime_error

if conversion is impossible or the value is not allowed.

Definition at line 91 of file Message.h.

---

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

• OnixS/CME/iLink3/messaging/TagBased/Message.h