Group.h

Go to the documentation of this file.

/*
* (c) Onix Solutions.
*/

#ifndef Group_h
#define Group_h

#include <string>
#include <iosfwd>

#include "FIXEngineDefines.h"
#include "EngineException.h"

namespace FIXForge{
namespace FIX{

class FF_API Message;

/// FIX Repeating Group.
class FF_API Group{
public:  
    /**
     * Returns 'true' if the message contains the field with the given tag, otherwise - 'false'.
     *
     * @param tag Tag number. 
     *  @param index Index of the repeating group instance.
     *
     * @return 'true' if the message contains the field with the given tag, otherwise - 'false'.
     */
    bool contain(int tag, int index) const;

    /**
     * Returns the field value as string.
     *
     * @param tag Tag number. 
     * @param index Index of the repeating group instance.
     */
    const std::string& get(int tag, int index); 

    /**
     * Returns the nested repeating group.
     *
     * @param numberOfInstancesTag Tag number of the field that defines the number of instances
     * in this repeating group (the NoXXX field). 
     *
     * @param index Index of the repeating group instance. 
     */
    Group* getGroup(int numberOfInstancesTag, int index);       

    /**
     * Returns the field value as integer. 
     *
     * @param tag Tag number. 
     * @param index Index of the repeating group instance.
     *
     * @warning Return 0 if the field value is absent.
     */
    int getInteger(int tag, int index) const;
        
    /**
     * Returns the field value as a floating-point number. 
     *
     * @param tag Tag number. 
     * @param index Index of the repeating group instance.
     *
     * @warning Return 0 if the field value is absent.
     */
    double getDouble(int tag, int index) const;

    /// Return the number of instances in this repeating group.
    size_t numberOfInstances();

    /**
     * Removes the field. 
     * 
     * @param tag Tag number. 
     * @param index Index of the repeating group instance.
     */
    bool remove(int tag, int index);

    /**
     * Returns 'true' if the given flag is present and it equals to "Y", otherwise 'false'.
     *
     * @param tag Tag number. 
     * @param index Index of the repeating group instance. 
     *
     * @return 'true' if the given flag is present and it equals to "Y", otherwise 'false'.
     */
    bool hasFlag(int tag, int index) const;

    /**
     * Sets the field value as string.  
     *
     * @param tag Tag number. 
     * @param index Index of the repeating group instance.
     * @param value Field value.
     */ 
    bool set(int tag, int index, const std::string& value);

    /**
    * Sets the field value as integer.  
    *
    * @param tag Tag number. 
    * @param index Index of the repeating group instance.
    * @param value Field value.
    */  
    bool set(int tag, int index, int 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 index Index of the repeating group instance.   
     * @param numberOfIntances Number of instances in the repeating group. 
     */
    Group* setGroup(int numberOfInstancesTag, int index, int numberOfIntances);   

    /**
    * Sets the given flag to "Y" or "N".
    *
    * @param tag Tag number. 
    * @param index Index of the repeating group instance. 
    * @param value Flag value.
    *
    * @return "true" if the flag had value before, otherwise "false" (the flag was inserted into the message).
    */
    bool setFlag(int tag, int index, bool value);

    /// Releases all Group resources (destroys the object). 
    void release();

private:
    /// Use Group::release() to free the resources instead of calling the destructor directly.
    ~Group();   

    Group(void* native, const Message* msg);     

    friend class Message;

    const Message* msg_;

    struct Impl;
    Impl* impl_;
};
}};

#endif

---