69 lines
1.8 KiB
C++
69 lines
1.8 KiB
C++
/**
|
|
* @file include/ActivOneApi/Messages/QueryAddMessage.h
|
|
*
|
|
* @brief Header for the QueryAddMessage class.
|
|
*/
|
|
|
|
#if (!defined ACTIV_ONE_API_MESSAGES_QUERY_ADD_MESSAGE_H)
|
|
#define ACTIV_ONE_API_MESSAGES_QUERY_ADD_MESSAGE_H
|
|
|
|
#include "ActivOneApi/External.h"
|
|
|
|
#include "ActivOneApi/TypeDefinitions.h"
|
|
|
|
//! Activ namespace.
|
|
namespace Activ
|
|
{
|
|
|
|
//! OneApi namespace.
|
|
namespace OneApi
|
|
{
|
|
|
|
//! QueryAddMessage class.
|
|
class QueryAddMessage
|
|
{
|
|
public:
|
|
/**
|
|
* @brief Constructor.
|
|
*
|
|
* @param dataSourceId
|
|
* @param tableNumber
|
|
* @param symbol
|
|
* @param topicType
|
|
* @param permissionId
|
|
*/
|
|
QueryAddMessage(const DataSourceId dataSourceId, const TableNo tableNumber, const String &symbol, const TopicType topicType,
|
|
const PermissionId permissionId);
|
|
|
|
/**
|
|
* @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 TableNo m_tableNumber; ///< The table that @a m_symbol belongs to (ACTIV only).
|
|
const String m_symbol; ///< The symbol.
|
|
const TopicType m_type; ///< The type of this topic.
|
|
const PermissionId m_permissionId; ///< The permission id of the topic.
|
|
};
|
|
|
|
// ---------------------------------------------------------------------------------------------------------------------------------
|
|
|
|
inline QueryAddMessage::QueryAddMessage(const DataSourceId dataSourceId, const TableNo tableNumber, const String &symbol,
|
|
const TopicType topicType, const PermissionId permissionId) :
|
|
m_dataSourceId(dataSourceId),
|
|
m_tableNumber(tableNumber),
|
|
m_symbol(symbol),
|
|
m_type(topicType),
|
|
m_permissionId(permissionId)
|
|
{
|
|
}
|
|
|
|
} // namespace OneApi
|
|
|
|
} // namespace Activ
|
|
|
|
#endif // (!defined ACTIV_ONE_API_MESSAGES_QUERY_ADD_MESSAGE_H)
|