Files

66 lines
1.7 KiB
C++

/**
* @file include/ActivOneApi/Messages/SnapshotFailureMessage.h
*
* @brief Header for the SnapshotFailureMessage class.
*/
#if (!defined ACTIV_ONE_API_MESSAGES_SNAPSHOT_FAILURE_MESSAGE_H)
#define ACTIV_ONE_API_MESSAGES_SNAPSHOT_FAILURE_MESSAGE_H
#include "ActivOneApi/External.h"
#include "ActivOneApi/TypeDefinitions.h"
//! Activ namespace.
namespace Activ
{
//! OneApi namespace.
namespace OneApi
{
//! SnapshotFailureMessage class.
class SnapshotFailureMessage : Boost::noncopyable
{
public:
/**
* @brief Constructor.
*
* @param dataSourceId
* @param symbologyId
* @param symbol
* @param statusCode
*/
SnapshotFailureMessage(const DataSourceId dataSourceId, const SymbologyId symbologyId, const String &symbol,
const StatusCode statusCode);
/**
* @brief Convert to a string.
*
* @return A long form string representation of the message contents.
*/
ACTIV_ONE_API String ToString() const;
const DataSourceId m_dataSourceId; ///< The DataSourceId of this message.
const SymbologyId m_symbologyId; ///< The SymbologyId of @a m_symbol.
const String & m_symbol; ///< The symbol.
const StatusCode m_statusCode; ///< The failure StatusCode.
};
// ---------------------------------------------------------------------------------------------------------------------------------
inline SnapshotFailureMessage::SnapshotFailureMessage(const DataSourceId dataSourceId, const SymbologyId symbologyId,
const String &symbol, const StatusCode statusCode) :
m_dataSourceId(dataSourceId),
m_symbologyId(symbologyId),
m_symbol(symbol),
m_statusCode(statusCode)
{
}
} // namespace OneApi
} // namespace Activ
#endif // (!defined ACTIV_ONE_API_MESSAGES_SNAPSHOT_FAILURE_MESSAGE_H)