50 lines
1.5 KiB
C++
50 lines
1.5 KiB
C++
/**
|
|
* @file include/ActivOneApi/Constants/TopicSubscriptionStates.h
|
|
*
|
|
* @brief Header for the TopicSubscriptionState definitions.
|
|
*/
|
|
|
|
#if (!defined ACTIV_ONE_API_CONSTANTS_TOPIC_SUBSCRIPTION_STATES_H)
|
|
#define ACTIV_ONE_API_CONSTANTS_TOPIC_SUBSCRIPTION_STATES_H
|
|
|
|
#include "ActivOneApi/External.h"
|
|
|
|
#include "ActivOneApi/TypeDefinitions.h"
|
|
|
|
//! Activ namespace.
|
|
namespace Activ
|
|
{
|
|
|
|
//! OneApi namespace.
|
|
namespace OneApi
|
|
{
|
|
|
|
// TopicSubscriptionState values.
|
|
const TopicSubscriptionState TOPIC_SUBSCRIPTION_STATE_PENDING = 0;
|
|
const TopicSubscriptionState TOPIC_SUBSCRIPTION_STATE_SYNCHRONIZING = 1;
|
|
const TopicSubscriptionState TOPIC_SUBSCRIPTION_STATE_OK = 2;
|
|
const TopicSubscriptionState TOPIC_SUBSCRIPTION_STATE_GAP = 3;
|
|
const TopicSubscriptionState TOPIC_SUBSCRIPTION_STATE_CLOSED = 4;
|
|
const TopicSubscriptionState TOPIC_SUBSCRIPTION_STATE_NOT_PERMISSIONED = 5;
|
|
const TopicSubscriptionState TOPIC_SUBSCRIPTION_STATE_MAX = 5;
|
|
|
|
// R7 compatibility.
|
|
const TopicSubscriptionState TOPIC_SUBSCRIPTION_STATE_SUBSCRIBING = TOPIC_SUBSCRIPTION_STATE_PENDING;
|
|
|
|
// ---------------------------------------------------------------------------------------------------------------------------------
|
|
|
|
/**
|
|
* @brief Convert a TopicSubscriptionState to a string.
|
|
*
|
|
* @param topicSubscriptionState
|
|
*
|
|
* @return String representation of @a topicSubscriptionState.
|
|
*/
|
|
ACTIV_ONE_API String TopicSubscriptionStateToString(const TopicSubscriptionState topicSubscriptionState);
|
|
|
|
} // namespace OneApi
|
|
|
|
} // namespace Activ
|
|
|
|
#endif // (!defined ACTIV_ONE_API_CONSTANTS_TOPIC_SUBSCRIPTION_STATES_H)
|