/** * @file include/ActivOneApi/Messages/RefreshMessage.h * * @brief Header for the RefreshMessage class. */ #if (!defined ACTIV_ONE_API_MESSAGES_REFRESH_MESSAGE_H) #define ACTIV_ONE_API_MESSAGES_REFRESH_MESSAGE_H #include "ActivOneApi/External.h" #include "ActivOneApi/MapKey.h" #include "ActivOneApi/TypeDefinitions.h" #include "ActivMiddleware/Misc/CrtHelper.h" //! Activ namespace. namespace Activ { //! OneApi namespace. namespace OneApi { class MessagePrivate; //! RefreshMessage class. class RefreshMessage : Boost::noncopyable { public: /** * @brief Constructor. * * @param dataSourceId * @param symbologyId * @param symbol */ RefreshMessage(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. TopicType m_topicType; ///< The topic type. PermissionId m_permissionId; ///< The permission id. TableNo m_tableNumber; ///< ACTIV specific table number. UpdateId m_updateId; ///< The update id. MapKey m_mapKey; ///< The map key. TopicSubscriptionState m_topicSubscriptionState; ///< The topic subscription state. const timespec * m_pGatewayTimestamp; ///< The optional gateway timestamp. const MessagePrivate * m_pPrivate; ///< @private }; // --------------------------------------------------------------------------------------------------------------------------------- inline RefreshMessage::RefreshMessage(const DataSourceId dataSourceId, const SymbologyId symbologyId, const String &symbol) : m_dataSourceId(dataSourceId), m_symbologyId(symbologyId), m_symbol(symbol), m_pGatewayTimestamp(ACTIV_NULLPTR) { } } // namespace OneApi } // namespace Activ #endif // (!defined ACTIV_ONE_API_MESSAGES_REFRESH_MESSAGE_H)