FixGroupEntry class

class V12.FIXAntenna.FixGroupEntry

Defines a repeating group entry of a FIX message.

get(tag: int) → str

Returns field value.

Parameters:: tag (int) – Tag of the field.
Returns:: Field value.
Return type:: str

get_group(starting_tag: int) → FixGroup

Returns nested repeating group.

The nested FIXGroup instance’s memory is managed by the FIX Engine. The FIXGroup instance is guaranteed to exist within its parent FIXMessage’s lifetime or until trimmed to zero length.

Parameters:: starting_tag (int) – Tag number of the leading field value.
Returns:: The returned value may be NULL, if the given tag exists for the group (according to the FIX protocol), but is not present in the requested group’s entry. If the tag is not defined for the group, then the method throws an exception.
Return type:: FixGroup

has_flag(tag: int) → bool

Checks boolean field.

Parameters:: tag (int) – Tag number of the field to verify.
Returns:: True if the given flag is present and it equals to “Y”, otherwise False.
Return type:: bool

is_empty(tag: int) → bool

Checks field emptiness. Opposite to has_value().

Parameters:: tag (int) – Tag number of the field to verify.
Returns:: True if the value is empty, otherwise False.
Return type:: bool

has_value(tag: int) → bool

Checks field emptiness. Opposite to is_empty().

Parameters:: tag (int) – Tag number of the field to verify.
Returns:: True if the value is set, otherwise False.
Return type:: bool

is_supported(tag: int) → bool

Verifies if the field is acceptable in the message.

Parameters:: tag (int) – Tag number of the field to verify.
Returns:: True if the field is supported by this message, otherwise False.
Return type:: bool

remove(tag: int) → bool

Empties field value by the tag number.

Parameters:: tag (int) – Tag of the field to remove.
Returns:: The returned value indicates previous value existence, i.e. if the previous value wasn’t empty, remove() returns True, otherwise False.
Return type:: bool

set(tag: int, value: str) → bool

Updates the field value by the tag number.

Parameters:

tag (int) – The FIX field tag to set data to.
value (str) – A new value for the field.

Returns:

The returned value indicates previous value existence, i.e. if the previous value wasn’t empty, set() returns True, otherwise False.

Return type:

bool