TraderLogonRequest Struct Reference

Public Types
enum
typedef SchemaTraits	Schema
typedef TraderLogonRequest	ThisType
Public Types inherited from SbeMessage
typedef MessageSize	EncodedLength
typedef MessageSize	BlockLength

Public Member Functions
	TraderLogonRequest ()=default
	TraderLogonRequest (void *data, EncodedLength length, SchemaVersion version=Schema::Version)
	TraderLogonRequest (void *data, EncodedLength length, NoFieldsInit, SchemaVersion version=Schema::Version)
	TraderLogonRequest (void *data, EncodedLength length, NoInit)
	TraderLogonRequest (SbeMessage message)
	TraderLogonRequest (void *data, EncodedLength length, NoInit, NoCheck) noexcept
auto	originatorUserId () const noexcept
ThisType &	originatorUserId (StrRef value) noexcept
auto	directElectronicAccess () const noexcept
ThisType &	directElectronicAccess (BooleanEnum value) noexcept
ThisType &	directElectronicAccess (NullOpt) noexcept
auto	tradingCapacity () const noexcept
ThisType &	tradingCapacity (TradingCapacityEnum value) noexcept
ThisType &	tradingCapacity (NullOpt) noexcept
auto	liquidityProvision () const noexcept
ThisType &	liquidityProvision (BooleanEnum value) noexcept
ThisType &	liquidityProvision (NullOpt) noexcept
auto	commodityDerivIndicator () const noexcept
ThisType &	commodityDerivIndicator (BooleanEnum value) noexcept
ThisType &	commodityDerivIndicator (NullOpt) noexcept
auto	investmentDecision () const noexcept
ThisType &	investmentDecision (Int64NULL value) noexcept
ThisType &	investmentDecision (NullOpt) noexcept
auto	executionDecision () const noexcept
ThisType &	executionDecision (Int64NULL value) noexcept
ThisType &	executionDecision (NullOpt) noexcept
auto	clientIdCode () const noexcept
ThisType &	clientIdCode (Int64NULL value) noexcept
ThisType &	clientIdCode (NullOpt) noexcept
auto	mifidId () const noexcept
ThisType &	mifidId (Int64NULL value) noexcept
ThisType &	mifidId (NullOpt) noexcept
auto	rawData () const noexcept
ThisType &	rawData (StrRef value) noexcept
ThisType &	resetVariableFields () noexcept
ThisType &	reset () noexcept
std::string	toString () const
const void *	tail () const noexcept
EncodedLength	calculateBinarySize () const noexcept
Public Member Functions inherited from SbeMessage
	SbeMessage () noexcept
	SbeMessage (void *data, MessageSize size, SchemaVersion version)
	SbeMessage (void *data, MessageSize size)
	SbeMessage (void *data, MessageSize size, NoCheck) noexcept
void	clear () noexcept
bool	valid () const noexcept
	operator bool () const noexcept
MessageTemplateId	templateId () const noexcept
SchemaVersion	version () const noexcept
SchemaId	schemaId () const noexcept
SequenceId	sequenceId () const noexcept
SbeMessage &	sequenceId (SequenceId value) noexcept
Timestamp	sendTime () const noexcept
SbeMessage &	sendTime (Timestamp value) noexcept
HeaderFlags	headerFlags () const noexcept
SbeMessage &	headerFlags (HeaderFlags value) noexcept
const void *	binary () const noexcept
void *	binary () noexcept
const void *	blockEnd () noexcept
const void *	blockEnd () const noexcept
MessageSize	bufferSize () const noexcept
void *	body () noexcept
BlockLength	blockLength () const noexcept
const void *	block () const noexcept
void *	block () noexcept
Public Member Functions inherited from SbeFields< Messaging::SbeMessage, MessageSize >
ONIXS_ICEBOE_FORCEINLINE Messaging::SbeMessage &	container () noexcept
void	zeroPaddingBytes (MessageSize offset) noexcept
ONIXS_ICEBOE_FORCEINLINE void	setOrdinary (MessageSize offset, FieldValue value) noexcept
ONIXS_ICEBOE_FORCEINLINE void	setEnumeration (MessageSize offset, Enumeration value) noexcept
ONIXS_ICEBOE_FORCEINLINE void	setFixedStr (MessageSize offset, StrRef value) noexcept

Static Public Member Functions
static constexpr BlockLength	minimalBlockLength (SchemaVersion version) noexcept
static constexpr BlockLength	blockLength (SchemaVersion version) noexcept
static constexpr MessageSize	getMinimalVariableFieldsSize (SchemaVersion version)
static constexpr UInt64	getMaxMessageSize (UInt8) noexcept
static constexpr StrRef	className () noexcept
static constexpr StrRef	fixType () noexcept

Additional Inherited Members
Protected Types inherited from SbeMessage
typedef SbeGroupList< MessageSize >	GroupList
typedef SbeVariableLengthFieldList< MessageSize >	VariableLengthFieldList
Protected Member Functions inherited from SbeMessage
SbeMessage &	version (SchemaVersion version) noexcept
GroupList	groups () noexcept
GroupList	groups () const noexcept
template<typename Group>
void	initGroup (Group &group, typename Group::EntrySize entrySize) noexcept
template<typename Group>
void	setupGroup (Group &group, typename Group::Size entryCount, const void *messageTail)
template<typename Group>
void	constructGroup (Group &group, typename Group::Size entryCount, const void *messageTail)
template<typename DATA>
void	setVarDataField (DATA &data, StrRef value, const void *oldMessageTail)
VariableLengthFieldList	variableLengthFields () noexcept
VariableLengthFieldList	variableLengthFields () const noexcept
void	init (MessageHeader::TemplateId value, MessageHeader::BlockLength minimalBlockLength, MessageHeader::BlockLength blockLength, SchemaId id) noexcept
MessageSize	calculateBinarySize (const void *tail) const noexcept
template<class Callable, class Owner>
void	setVariableLengthField (Callable callable, StrRef value, Owner &owner)
template<class Callable, class Owner>
void	setVariableLengthField (Callable callable, StrRef value, SchemaVersion since, Owner &owner)
template<class Callable, class Owner>
StrRef	getVariableLengthField (Callable callable, const Owner &owner) const noexcept
template<class Callable, class Owner>
StrRef	getVariableLengthField (Callable callable, SchemaVersion since, Owner &owner) const noexcept
template<class Callable, class Owner>
void	setVariableLengthFieldToNull (Callable callable, Owner &owner) noexcept
template<class Group, class Callable, class Owner>
void	resetGroup (Callable callable, Owner &owner) noexcept
template<class Callable, class Owner>
void	setVariableLengthFieldToNull (Callable callable, SchemaVersion since, Owner &owner) noexcept
template<class Group, class Callable, class Owner>
void	resetGroup (Callable callable, SchemaVersion since, Owner &owner)
template<class Group, class Callable, class Owner>
ONIXS_ICEBOE_FORCEINLINE Group	getGroup (Callable callable, Owner &owner) const noexcept
template<class Group, class Callable, class Owner>
ONIXS_ICEBOE_FORCEINLINE Group	getGroup (Callable callable, SchemaVersion since, Owner &owner) const noexcept
template<class Group, class Callable, class Owner>
ONIXS_ICEBOE_FORCEINLINE Group	constructGroup (Callable callable, typename Group::Size length, SchemaVersion since, Owner &owner)
template<class Group, class Callable, class Owner>
ONIXS_ICEBOE_FORCEINLINE Group	constructGroup (Callable callable, typename Group::Size length, Owner &owner)
template<class Group, class Callable, class Owner>
Group	setupGroup (Callable callable, typename Group::Size length, SchemaVersion since, Owner &owner)
template<class Group, class Callable, class Owner>
Group	setupGroup (Callable callable, typename Group::Size length, Owner &owner)
Protected Member Functions inherited from SbeFields< Messaging::SbeMessage, MessageSize >
	SbeFields ()=default
	~SbeFields ()=default
Protected Member Functions inherited from BinaryBlock< Messaging::SbeMessage, MessageSize >
	BinaryBlock ()=default
	~BinaryBlock ()=default
ONIXS_ICEBOE_FORCEINLINE Value	ordinary (MessageSize offset) const noexcept
ONIXS_ICEBOE_FORCEINLINE Enumeration	enumeration (MessageSize offset) const noexcept
ONIXS_ICEBOE_FORCEINLINE StrRef	fixedStr (MessageSize offset) const noexcept
ONIXS_ICEBOE_FORCEINLINE Value	decimal (MessageSize offset) const noexcept
ONIXS_ICEBOE_FORCEINLINE std::enable_if<!isComposite< typenameNullValue::Value >::value, SbeOptionalConverted< decltype(std::declval< Callable >()(std::declval< typenameArgType< Callable >::type >()))> >::type	convertible (MessageSize offset, OptionalTag) const noexcept(noexcept(Callable::Nothrow))
Protected Member Functions inherited from BinaryBlockBase
	~BinaryBlockBase ()=default
Static Protected Member Functions inherited from SbeMessage
static constexpr MessageSize	getMaxMessageSize () noexcept

Detailed Description

Definition at line 8979 of file Messages.h.

Member Typedef Documentation

Schema

typedef SchemaTraits Schema

Used template schema.

Definition at line 8984 of file Messages.h.

ThisType

typedef TraderLogonRequest ThisType

This type alias.

Definition at line 8987 of file Messages.h.

Member Enumeration Documentation

anonymous enum

anonymous enum

Message template ID from SBE schema.

Enumerator
TemplateId	2

Definition at line 8990 of file Messages.h.

{ TemplateId = 2 };

Constructor & Destructor Documentation

TraderLogonRequest() [1/6]

TraderLogonRequest ( )

default

Initializes a blank instance.

TraderLogonRequest() [2/6]

TraderLogonRequest ( void * data, EncodedLength length, SchemaVersion version = Schema::Version )

inline

Initializes an instance over the given memory block.

Definition at line 8996 of file Messages.h.

      : SbeMessage(data, length, version)
    {
        checkVersion<Schema>(version);
        checkLength(length, version);
        init(TemplateId, minimalBlockLength(version), blockLength(version), Schema::Id);
        reset();
    }

TraderLogonRequest() [3/6]

TraderLogonRequest ( void * data, EncodedLength length, NoFieldsInit , SchemaVersion version = Schema::Version )

inline

Initializes an instance over the given memory block With no variable-length fields initialization It is assumed that the user does such an initialization manually.

Definition at line 9008 of file Messages.h.

      : SbeMessage(data, length, version)
    {
        checkVersion<Schema>(version);
        checkLength(length, version);
        init(TemplateId, minimalBlockLength(version), blockLength(version), Schema::Id);
        resetVariableFields();
    }

TraderLogonRequest() [4/6]

TraderLogonRequest ( void * data, EncodedLength length, NoInit  )

inline

Creates an instance over the given memory block.

Definition at line 9018 of file Messages.h.

      : SbeMessage(data, length)
    {
        checkCompatibility();
    }

TraderLogonRequest() [5/6]

TraderLogonRequest ( SbeMessage message )

inlineexplicit

Creates an instance over the given SBE message.

Definition at line 9026 of file Messages.h.

      : SbeMessage(message)
    {
        assert(message.valid());
 
        checkCompatibility();
    }

TraderLogonRequest() [6/6]

TraderLogonRequest ( void * data, EncodedLength length, NoInit , NoCheck  )

inlinenoexcept

Creates an instance over the given memory block.

Performs no checks.

Definition at line 9036 of file Messages.h.

      : SbeMessage(data, length, NoCheck())
    {
        assert(schemaId() == Schema::Id);
        assert(version() >= Schema::MinimalVersion);
        assert(TemplateId == templateId());
    }

Member Function Documentation

blockLength()

constexpr BlockLength blockLength ( SchemaVersion version )

inlinestaticconstexprnoexcept

Size of message body in bytes.

Definition at line 9303 of file Messages.h.

    {
        return
            ONIXS_ICEBOE_ASSERT(version >= Schema::MinimalVersion),
            minimalBlockLength(version);
    }

calculateBinarySize()

EncodedLength calculateBinarySize ( ) const

inlinenoexcept

Returns

the size occupied by the message.

Definition at line 9386 of file Messages.h.

    {
        return
            SbeMessage::calculateBinarySize(tail());
    }

className()

constexpr StrRef className ( )

inlinestaticconstexprnoexcept

Returns

class name.

Definition at line 9355 of file Messages.h.

    {
        return constructStrRef("TraderLogonRequest");
    }

clientIdCode() [1/3]

auto clientIdCode ( ) const

inlinenoexcept

int64NULL.

Definition at line 9222 of file Messages.h.

    {
        constexpr BlockLength offset = 40;
 
        return ordinary<NullInt64NULL>(offset, optional);
    }

clientIdCode() [2/3]

ThisType & clientIdCode ( Int64NULL value )

inlinenoexcept

int64NULL.

Definition at line 9230 of file Messages.h.

    {
        constexpr BlockLength offset = 40;
 
        setOrdinary(offset, value);
        return *this;
    }

clientIdCode() [3/3]

ThisType & clientIdCode ( NullOpt )

inlinenoexcept

Definition at line 9238 of file Messages.h.

    {
        constexpr BlockLength offset = 40;
 
        setOrdinary(offset, NullInt64NULL());
        return *this;
    }

commodityDerivIndicator() [1/3]

auto commodityDerivIndicator ( ) const

inlinenoexcept

uint8NULL.

Definition at line 9144 of file Messages.h.

    {
        constexpr BlockLength offset = 23;
 
        return enumeration<BooleanEnum, NullUint8NULL>(offset, optional);
    }

commodityDerivIndicator() [2/3]

ThisType & commodityDerivIndicator ( BooleanEnum value )

inlinenoexcept

uint8NULL.

Definition at line 9152 of file Messages.h.

    {
        constexpr BlockLength offset = 23;
 
        setEnumeration<BooleanEnum>(offset, value);
        return *this;
    }

commodityDerivIndicator() [3/3]

ThisType & commodityDerivIndicator ( NullOpt )

inlinenoexcept

Definition at line 9160 of file Messages.h.

    {
        constexpr BlockLength offset = 23;
 
        setOrdinary(offset, NullUint8NULL());
        return *this;
    }

directElectronicAccess() [1/3]

auto directElectronicAccess ( ) const

inlinenoexcept

uint8NULL.

Definition at line 9066 of file Messages.h.

    {
        constexpr BlockLength offset = 20;
 
        return enumeration<BooleanEnum, NullUint8NULL>(offset, optional);
    }

directElectronicAccess() [2/3]

ThisType & directElectronicAccess ( BooleanEnum value )

inlinenoexcept

uint8NULL.

Definition at line 9074 of file Messages.h.

    {
        constexpr BlockLength offset = 20;
 
        setEnumeration<BooleanEnum>(offset, value);
        return *this;
    }

directElectronicAccess() [3/3]

ThisType & directElectronicAccess ( NullOpt )

inlinenoexcept

Definition at line 9082 of file Messages.h.

    {
        constexpr BlockLength offset = 20;
 
        setOrdinary(offset, NullUint8NULL());
        return *this;
    }

executionDecision() [1/3]

auto executionDecision ( ) const

inlinenoexcept

int64NULL.

Definition at line 9196 of file Messages.h.

    {
        constexpr BlockLength offset = 32;
 
        return ordinary<NullInt64NULL>(offset, optional);
    }

executionDecision() [2/3]

ThisType & executionDecision ( Int64NULL value )

inlinenoexcept

int64NULL.

Definition at line 9204 of file Messages.h.

    {
        constexpr BlockLength offset = 32;
 
        setOrdinary(offset, value);
        return *this;
    }

executionDecision() [3/3]

ThisType & executionDecision ( NullOpt )

inlinenoexcept

Definition at line 9212 of file Messages.h.

    {
        constexpr BlockLength offset = 32;
 
        setOrdinary(offset, NullInt64NULL());
        return *this;
    }

fixType()

constexpr StrRef fixType ( )

inlinestaticconstexprnoexcept

FIX message type.

Definition at line 9363 of file Messages.h.

    {
        return constructStrRef("TraderLogonRequest");
    }

getMaxMessageSize()

constexpr UInt64 getMaxMessageSize ( UInt8 )

inlinestaticconstexprnoexcept

Maximal message size.

Definition at line 9323 of file Messages.h.

    {
        return
            static_cast<UInt64>(MessageHeaderBuilder::Size) +
            blockLength(Schema::Version);
    }

getMinimalVariableFieldsSize()

constexpr MessageSize getMinimalVariableFieldsSize ( SchemaVersion version )

inlinestaticconstexpr

Minimal variable fields size (when variable-length fields are empty).

Definition at line 9313 of file Messages.h.

    {
        return
            ONIXS_ICEBOE_ASSERT(version >= Schema::MinimalVersion),
            0;
    }

investmentDecision() [1/3]

auto investmentDecision ( ) const

inlinenoexcept

int64NULL.

Definition at line 9170 of file Messages.h.

    {
        constexpr BlockLength offset = 24;
 
        return ordinary<NullInt64NULL>(offset, optional);
    }

investmentDecision() [2/3]

ThisType & investmentDecision ( Int64NULL value )

inlinenoexcept

int64NULL.

Definition at line 9178 of file Messages.h.

    {
        constexpr BlockLength offset = 24;
 
        setOrdinary(offset, value);
        return *this;
    }

investmentDecision() [3/3]

ThisType & investmentDecision ( NullOpt )

inlinenoexcept

Definition at line 9186 of file Messages.h.

    {
        constexpr BlockLength offset = 24;
 
        setOrdinary(offset, NullInt64NULL());
        return *this;
    }

liquidityProvision() [1/3]

auto liquidityProvision ( ) const

inlinenoexcept

uint8NULL.

Definition at line 9118 of file Messages.h.

    {
        constexpr BlockLength offset = 22;
 
        return enumeration<BooleanEnum, NullUint8NULL>(offset, optional);
    }

liquidityProvision() [2/3]

ThisType & liquidityProvision ( BooleanEnum value )

inlinenoexcept

uint8NULL.

Definition at line 9126 of file Messages.h.

    {
        constexpr BlockLength offset = 22;
 
        setEnumeration<BooleanEnum>(offset, value);
        return *this;
    }

liquidityProvision() [3/3]

ThisType & liquidityProvision ( NullOpt )

inlinenoexcept

Definition at line 9134 of file Messages.h.

    {
        constexpr BlockLength offset = 22;
 
        setOrdinary(offset, NullUint8NULL());
        return *this;
    }

mifidId() [1/3]

auto mifidId ( ) const

inlinenoexcept

int64NULL.

Definition at line 9248 of file Messages.h.

    {
        constexpr BlockLength offset = 48;
 
        return ordinary<NullInt64NULL>(offset, optional);
    }

mifidId() [2/3]

ThisType & mifidId ( Int64NULL value )

inlinenoexcept

int64NULL.

Definition at line 9256 of file Messages.h.

    {
        constexpr BlockLength offset = 48;
 
        setOrdinary(offset, value);
        return *this;
    }

mifidId() [3/3]

ThisType & mifidId ( NullOpt )

inlinenoexcept

Definition at line 9264 of file Messages.h.

    {
        constexpr BlockLength offset = 48;
 
        setOrdinary(offset, NullInt64NULL());
        return *this;
    }

minimalBlockLength()

constexpr BlockLength minimalBlockLength ( SchemaVersion version )

inlinestaticconstexprnoexcept

Minimal size of message body in bytes.

Definition at line 9294 of file Messages.h.

    {
        return
            ONIXS_ICEBOE_ASSERT(version >= Schema::MinimalVersion),
            106;
    }

originatorUserId() [1/2]

auto originatorUserId ( ) const

inlinenoexcept

Trader ID.

Definition at line 9046 of file Messages.h.

    {
        constexpr BlockLength offset = 0;
        constexpr BlockLength length = 20;
 
        return fixedStr<length>(offset);
    }

originatorUserId() [2/2]

ThisType & originatorUserId ( StrRef value )

inlinenoexcept

Trader ID.

Definition at line 9055 of file Messages.h.

    {
        constexpr BlockLength offset = 0;
        constexpr BlockLength length = 20;
 
        setFixedStr<length>(offset, value);
        return *this;
    }

rawData() [1/2]

auto rawData ( ) const

inlinenoexcept

Password of Trader ID.

Definition at line 9274 of file Messages.h.

    {
        constexpr BlockLength offset = 56;
        constexpr BlockLength length = 50;
 
        return fixedStr<length>(offset);
    }

rawData() [2/2]

ThisType & rawData ( StrRef value )

inlinenoexcept

Password of Trader ID.

Definition at line 9283 of file Messages.h.

    {
        constexpr BlockLength offset = 56;
        constexpr BlockLength length = 50;
 
        setFixedStr<length>(offset, value);
        return *this;
    }

reset()

ThisType & reset ( )

inlinenoexcept

Reset all variable-length and optional fields if any.

Definition at line 9337 of file Messages.h.

    {
        directElectronicAccess(nullOpt);
        tradingCapacity(nullOpt);
        liquidityProvision(nullOpt);
        commodityDerivIndicator(nullOpt);
        investmentDecision(nullOpt);
        executionDecision(nullOpt);
        clientIdCode(nullOpt);
        mifidId(nullOpt);
 
        resetVariableFields();
        return *this;
    }

resetVariableFields()

ThisType & resetVariableFields ( )

inlinenoexcept

Reset all variable-length fields if any.

Definition at line 9331 of file Messages.h.

    {
        return *this;
    }

tail()

const void * tail ( ) const

inlinenoexcept

Returns

the end of the message.

Definition at line 9374 of file Messages.h.

    {
        return
            toOpaquePtr(
                advanceByBytes(
                    binary(),
                    static_cast<ptrdiff_t>(SbeMessage::blockLength()) +
                        MessageHeader::Size));
    }

toString()

std::string toString ( ) const

inline

Returns

a human-readable presentation.

Definition at line 809 of file MessageSerialization.h.

{
    return toStr(*this);
}

tradingCapacity() [1/3]

auto tradingCapacity ( ) const

inlinenoexcept

uint8NULL.

Definition at line 9092 of file Messages.h.

    {
        constexpr BlockLength offset = 21;
 
        return enumeration<TradingCapacityEnum, NullUint8NULL>(offset, optional);
    }

tradingCapacity() [2/3]

ThisType & tradingCapacity ( NullOpt )

inlinenoexcept

Definition at line 9108 of file Messages.h.

    {
        constexpr BlockLength offset = 21;
 
        setOrdinary(offset, NullUint8NULL());
        return *this;
    }

tradingCapacity() [3/3]

ThisType & tradingCapacity ( TradingCapacityEnum value )

inlinenoexcept

uint8NULL.

Definition at line 9100 of file Messages.h.

    {
        constexpr BlockLength offset = 21;
 
        setEnumeration<TradingCapacityEnum>(offset, value);
        return *this;
    }