GeneralError.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 <OnixS/Senaf/MarketData/Export.h>

#include <iosfwd>
#include <string>

namespace OnixS { namespace Senaf { namespace MarketData {

/// General Error.
struct ONIXS_BME_SENAF_EXPORT GeneralError
{
    /// Message code.
    enum { code = 105 };

    /// Default constructor.
    GeneralError();

    /// Market.
    unsigned char market;

    /// Error Generator.
    unsigned char errorGenerator;

    /// Error Type.
    unsigned char errorType;

    /// Text Description.
    std::string textDescription;

    /// Returns string representation.
    std::string toString() const;

private:
    friend class MessageDeserializer;
    GeneralError(const char* data, size_t dataSize);
    void deserialize(const char* data, size_t dataSize);
    void reset();
};

/// Make it printable using C++ I/O streams.
ONIXS_BME_SENAF_EXPORT std::ostream& operator<<(std::ostream&, const GeneralError&);

}}}