Dictionary.h

Go to the documentation of this file.

/*
* Copyright Onix Solutions Limited [OnixS]. All rights reserved.
*
* This software owned by Onix Solutions Limited [OnixS] and is protected by copyright law
* and international copyright treaties.
*
* Access to and use of the software is governed by the terms of the applicable OnixS Software
* Services Agreement (the Agreement) and Customer end user license agreements granting
* a non-assignable, non-transferable and non-exclusive license to use the software
* for it's own data processing purposes under the terms defined in the Agreement.
*
* Except as otherwise granted within the terms of the Agreement, copying or reproduction of any part
* of this source code or associated reference material to any other location for further reproduction
* or redistribution, and any amendments to this copyright notice, are expressly prohibited.
*
* Any reproduction or redistribution for sale or hiring of the Software not in accordance with
* the terms of the Agreement is a violation of copyright law.
*/
 
#pragma once
 
#include <string>
#include <vector>
 
#include <OnixS/FIXEngine/FIX/Tag.h>
#include <OnixS/FIXEngine/FIX/ProtocolVersion.h>
 
namespace OnixS {
namespace FIX {

struct FieldValueTypes {
    enum Enum {
        Unknown,
        Amt,
        Boolean,
        Char,
        Country,
        Currency,
        DayOfMonth,
        Data,
        Exchange,
        Float,
        Int,
        Length,
        Language,
        LocalMktDate,
        MultipleValueString,
        MultipleCharValue,
        MultipleStringValue,
        MonthYear,
        NumInGroup,
        Price,
        PriceOffset,
        Percentage,
        Pattern,
        Qty,
        Reserved1000Plus,
        Reserved100Plus,
        Reserved4000Plus,
        SeqNum,
        String,
        TzTimeOnly,
        TzTimeStamp,
        TagNum,
        Tenor,
        UtcDate,
        UtcTimeStamp,
        UtcTimeOnly,
        UtcDateOnly,
        XmlData,
        LocalMktTime,
        XID,
        XIDREF
    };

    ONIXS_FIXENGINE_API
    static const char * toString(Enum fieldValueType);

    ONIXS_FIXENGINE_API
    static Enum parse(const std::string & fieldValueType);
};

class ONIXS_FIXENGINE_API ValidFieldValue
{
public:
    std::string value() const;

    std::string description() const;
 
private:
 
    friend class MessageOperator;
 
    const char * value_;
    const char * description_;
 
    ValidFieldValue(const char * value, const char * description);
};

class ONIXS_FIXENGINE_API FieldInfo
{
public:
    Tag tag() const;

    bool isRequired() const;

    std::vector<FieldInfo> childFields() const;
 
private:
 
    friend class MessageOperator;
 
    const void * impl_;
 
    FieldInfo(const void *);
};

class ONIXS_FIXENGINE_API Dictionary
{
public:
    Dictionary(const char * id);

    Dictionary(ProtocolVersion::Enum version);

    const std::string & id() const;

    ProtocolVersion::Enum version() const;

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

    FieldValueTypes::Enum fieldType(Tag tag) const;

    Tag fieldNumber(const std::string & name) const;

    std::string fieldValueDescription(Tag tag, const std::string & value) const;

    typedef std::vector<ValidFieldValue> ValidFieldValues;

    ValidFieldValues validFieldValues(Tag tag) const;

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

    MessageTypes messageTypes() const;

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

    typedef std::vector<FieldInfo> FieldInfos;

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

    typedef std::vector<Tag> Tags;

    Tags tags() const;

    bool operator == (const Dictionary & other) const;

    bool operator != (const Dictionary & other) const;

    void swap(Dictionary & other);
 
private:
    friend class MessageOperator;
 
    const void * impl_;
 
    Dictionary(const void *);
};
}
}