Files

67 lines
1.6 KiB
C++

/**
* @file include/ActivOneApi/Messages/SnapshotMessage.h
*
* @brief Header for the SnapshotMessage class.
*/
#if (!defined ACTIV_ONE_API_MESSAGES_SNAPSHOT_MESSAGE_H)
#define ACTIV_ONE_API_MESSAGES_SNAPSHOT_MESSAGE_H
#include "ActivOneApi/External.h"
#include "ActivOneApi/TypeDefinitions.h"
//! Activ namespace.
namespace Activ
{
//! OneApi namespace.
namespace OneApi
{
class MessagePrivate;
//! SnapshotMessage class.
class SnapshotMessage : Boost::noncopyable
{
public:
/**
* @brief Constructor.
*
* @param dataSourceId
* @param symbologyId
* @param symbol
*/
SnapshotMessage(const DataSourceId dataSourceId, const SymbologyId symbologyId, const String &symbol);
/**
* @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.
PermissionId m_permissionId; ///< The permission id.
UpdateId m_updateId; ///< The update id.
const MessagePrivate * m_pPrivate; ///< @private
};
// ---------------------------------------------------------------------------------------------------------------------------------
inline SnapshotMessage::SnapshotMessage(const DataSourceId dataSourceId, const SymbologyId symbologyId, const String &symbol) :
m_dataSourceId(dataSourceId),
m_symbologyId(symbologyId),
m_symbol(symbol)
{
}
} // namespace OneApi
} // namespace Activ
#endif // (!defined ACTIV_ONE_API_MESSAGES_SNAPSHOT_MESSAGE_H)