Message.h

Go to the documentation of this file.

/*
* (c) Onix Solutions.
*/

#ifndef Message_h
#define Message_h

#include <iosfwd>
#include <string>

#include "FIXEngineDefines.h"
#include "EngineException.h"
#include "Session.h"
#include "FIXEngine.h"

namespace FIXForge{
namespace FIX{

namespace FAST_1_1{
    class Encoder;
    class Decoder;
};

class FF_API Group;

/// FIX Message.
class FF_API Message{
public: 
    /// Validation options.
    enum ValidationOptions
    {
        CHECK_LENGTH = 2,
        CHECK_CHECK_SUM = 4
    };

    /// Constructs the FIX message object from the native (tag=value) representation.
    Message(const std::string& nativeFixMessage);

    /**
     * Constructs the FIX message object from the native (tag=value) representation.
     *
     * @param nativeFixMessage The native (raw) FIX message in the 'tag=value' format.
     * @param validationOptions Several ValidationOptions values can be joined using '|'.
     */
    Message(const std::string& nativeFixMessage, int validationOptions);

    /// Constructor
    Message(const std::string& type, Version version);

    /// Constructor
    Message(const char* type, Version version);

    /// Copy Constructor.
    Message(const Message& msg);

    /// Destructor.
    ~Message();

    bool operator == (const Message& rh);
    bool operator != (const Message& rh);

    friend FF_API std::ostream& operator<< (std::ostream& os, const Message& msg);

    /// Updates the BodyLength (9) and CheckSum (10) fields.
    void updateCheckSum();
    
    /// Returns 'true' if the message contains the field with the given tag, otherwise - 'false'.
    bool contain(int tag) const;

    /// Returns the field value as a string.
    const std::string& get(int tag) const;

    /**
     * Returns the field value as a floating-point number.
     *
     * @warning Return 0 if the field value is absent.
     */
    double getDouble(int tag) const;

    /**
     * Returns the repeating group. 
     *
     * @param numberOfInstancesTag Tag number of the field that defines the number of instances in this repeating group (the NoXXX field). 
     *
     * @warning To avoid memory leaks call Group::release() when the Group object is not used anymore.
     */
    Group* getGroup(int numberOfInstancesTag) const;        

    /**
     * Returns the field value as an integer.
     * 
     * @warning Return 0 if the field value is absent.
     */
    int getInteger(int tag) const;      

    /// Returns the assigned value used to identify firm sending message (SenderCompID (49) field value).   
    const std::string& getSenderCompID() const;

    /// Returns the message sequence number (the MsgSeqNum (tag=34) field value).
    int getSeqNum() const;  

    /// Returns the assigned value used to identify receiving firm (TargetCompID(56) field value).
    const std::string& getTargetCompID() const;

    /// Returns the message type (MsgType(35) field value).
    const std::string& getType() const;     

    /// Returns the Financial Interface eXchange (FIX) protocol version.
    Version getVersion() const;

    /// Returns true if the given flag is present and it equals to "Y", otherwise false.
    bool hasFlag(int tag) const;

    /// Removes the field.
    bool remove(int tag);

    /// Sets the integer field value.
    bool set(int tag, int value);

    /// Sets the double field value.
    bool set(int tag, double value);

    /// Sets the string field value.
    bool set(int tag, const std::string& value);

    /**
    * Sets the given flag to "Y" or "N".
    *
    * @return "true" if the flag had value before, otherwise "false" (the flag was inserted into the message).
    */
    void setFlag(int tag, bool value);

    /**
     * Creates a new repeating group or changes the number of instances in the existing repeatign group. 
     *
     * @param numberOfInstancesTag Tag number of the field that defines the number of instances in this repeating group (the NoXXX field). 
     *
     * @param numberOfIntances Number of instances in the repeating group. 
     */
    Group* setGroup(int numberOfInstancesTag, int numberOfIntances);  
        
    /// Sets the assigned value used to identify firm sending message (SenderCompID (49) field value).  
    void setSenderCompID(const std::string& value);

    /// Sets the message sequence number (the MsgSeqNum (tag=34) field value).
    void setSeqNum(int value);      

    /// Sets the assigned value used to identify receiving firm (TargetCompID(56) field value).
    void setTargetCompID(const std::string& value);
    
    /// Returns the &lt;tag&gt;=&lt;value&gt; string representation of the message using the standard FIX delimiter ('0x01').
    const std::string& toString() const;

    /// Returns the &lt;tag&gt;=&lt;value&gt; string representation of the message using the given delimiter.
    const std::string& toString(char delimiter) const;

    /// Format of the message string representation.
    enum FORMAT{
        TAG_NUMBER = 1,
        TAG_NAME = 2
    };

    /**
     * Returns the &lt;tag&gt;=&lt;value&gt; string representation of the message using the given format and delimiter.
     *
     * @param format Format of the string representation, several FORMAT values could be joined using logical 'or' operator.
     * @param delimiter Fields delimiter.
     *
     * @see FORMAT
     */ 
    const std::string& toString(int format, char delimiter = ' ') const;
    
    /// Validates the message.
    void validate() const;

private:            
    Message(void* native, bool isOwner = false);    
    Message& operator = (const Message&);

    void init(const char* type, Version version);

    struct Impl;
    Impl* impl_;

    void* native_;

    friend class Session;
    friend struct Session::Impl;
    friend struct Engine::Impl; 
    friend class FAST_1_1::Encoder;
    friend class FAST_1_1::Decoder; 
};

}};

#endif

---