OnixS C++ FIX Engine  4.3.0
API Documentation
Dictionary Class Reference

#include <OnixS/FIXEngine/FIX/Dictionary.h>

Public Types

typedef std::vector< ValidFieldValueValidFieldValues
 
typedef std::vector< std::string > MessageTypes
 
typedef std::vector< FieldInfoFieldInfos
 
typedef std::vector< TagTags
 

Public Member Functions

 Dictionary (const char *id)
 
 Dictionary (ProtocolVersion::Enum version)
 
const std::string & id () const
 
ProtocolVersion::Enum version () const
 
const std::string & fieldName (Tag tag) const
 
Tag fieldNumber (const std::string &name) const
 
std::string fieldValueDescription (Tag tag, const std::string &value) const
 
ValidFieldValues validFieldValues (Tag tag) const
 
MessageTypes messageTypes () const
 
std::string messageName (const std::string &type) const
 
FieldInfos messageFields (const std::string &type) const
 
Tags tags () const
 
bool operator== (const Dictionary &other) const
 
bool operator!= (const Dictionary &other) const
 
void swap (Dictionary &other)
 

Friends

class MessageOperator
 

Detailed Description

Definition at line 73 of file Dictionary.h.

Member Typedef Documentation

typedef std::vector<FieldInfo> FieldInfos

Collection of FIX field information.

Definition at line 136 of file Dictionary.h.

typedef std::vector<std::string> MessageTypes

Collection of message types.

Definition at line 124 of file Dictionary.h.

typedef std::vector<Tag> Tags

Collection of tag numbers.

Definition at line 142 of file Dictionary.h.

typedef std::vector<ValidFieldValue> ValidFieldValues

Collection of valid field values.

Definition at line 114 of file Dictionary.h.

Constructor & Destructor Documentation

Dictionary ( const char *  id)

Initializes dictionary according to the definition from the Engine configuration file.

Parameters
idIdentifier of FIX dictionary as specified in Dictionary XML description by the 'id' attribute of the 'FIX' node.

Creates the dictionary that corresponds the given FIX Protocol version.

Member Function Documentation

const std::string& fieldName ( Tag  tag) const

Returns name of corresponding FIX field.

Returns
name of corresponding FIX field or empty string if field is unknown.
Tag fieldNumber ( const std::string &  name) const

Returns tag number of corresponding FIX field.

Returns
tag number of corresponding FIX field or 0 if field is unknown.
std::string fieldValueDescription ( Tag  tag,
const std::string &  value 
) const

Returns value description (if it exists) of corresponding FIX field value.

Returns
value description of corresponding FIX field value or the empty string if there is no a description for this field value or the field is unknown.
const std::string& id ( ) const

Dictionary unique identifier.

FieldInfos messageFields ( const std::string &  type) const

Returns a collection of field descriptions that belong to the given message.

std::string messageName ( const std::string &  type) const

Returns the message name by the given message type.

Returns
the message name by the given message type or the empty string if the message type is unknown.
MessageTypes messageTypes ( ) const

Returns a collection of types of all messages available in this particular FIX dictionary.

bool operator!= ( const Dictionary other) const

Compares two dictionaries by their identifiers.

bool operator== ( const Dictionary other) const

Compares two dictionaries by their identifiers.

void swap ( Dictionary other)

Swaps two instances.

Tags tags ( ) const

Returns a collection of all tags which belong to the dialect.

ValidFieldValues validFieldValues ( Tag  tag) const

Returns valid field values (if they exist) of corresponding FIX field.

Returns
a set of valid field values of corresponding FIX field value or the empty set if there is no known valid field values for this field or the field is unknown.
ProtocolVersion::Enum version ( ) const

Version of the FIX messaging specification (protocol) on which the dictionary is based.

Friends And Related Function Documentation

friend class MessageOperator
friend

Definition at line 157 of file Dictionary.h.


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