DATA_TAG

Stores (name, value) pairs that can be used to determine access permissions. More...

Classes
class	DDS::Tag
	Tags are name/value pair objects. More...
class	DDS::TagSeq
	Declares IDL sequence < DDS::Tag > More...
class	DDS::DataTagQosPolicy
	Stores (name, value) pairs that can be used to determine access permissions. More...
class	DDS::DataTagQosPolicyHelper
	Policy helpers that facilitate management of the data tags in the input policy. More...

Functions
static System::String ^	DDS::DataTagQosPolicy::get_datatag_qos_policy_name ()
	Stringified human-readable name for DDS::DataTagQosPolicy. More...
static Int32	DDS::DataTagQosPolicyHelper::get_number_of_tags (DataTagQosPolicy^ policy)
	Gets the number of data tags in the input policy. More...
static void	DDS::DataTagQosPolicyHelper::assert_tag (DataTagQosPolicy^ policy, String^ name, String^ value)
	Asserts the tag identified by name in the input policy. More...
static void	DDS::DataTagQosPolicyHelper::add_tag (DataTagQosPolicy^ policy, String^ name, String^ value)
	Adds a new tag to the input policy. More...
static Tag ^	DDS::DataTagQosPolicyHelper::lookup_tag (DataTagQosPolicy^ policy, String^ name)
	Searches by tag name for a tag in the input policy. More...
static void	DDS::DataTagQosPolicyHelper::remove_tag (DataTagQosPolicy^ policy, String^ name)
	Removes a tag from the input policy. More...

Detailed Description

Stores (name, value) pairs that can be used to determine access permissions.

The DDS::DataTagQosPolicy can be used to associate a set of tags in the form of (name, value) pairs with a DDS::DataReader or DDS::DataWriter. This is similar to the DDS::PropertyQosPolicy, except you cannot select whether or not a particular pair should be propagated (included in the built-in topic). Data tags are always propagated. The Access Control plugin may use the tags to determine publish and subscribe permissions.

Function Documentation

get_datatag_qos_policy_name()

static System::String ^ DDS::DataTagQosPolicy::get_datatag_qos_policy_name ( )

inlinestatic

Stringified human-readable name for DDS::DataTagQosPolicy.

get_number_of_tags()

static Int32 DDS::DataTagQosPolicyHelper::get_number_of_tags ( DataTagQosPolicy^  policy )

static

Gets the number of data tags in the input policy.

Precondition

policy cannot be null.

Parameters

policy

<<in>> Input policy.

Returns

Number of data tags.

assert_tag()

static void DDS::DataTagQosPolicyHelper::assert_tag ( DataTagQosPolicy^  policy, String^  name, String^  value  )

static

Asserts the tag identified by name in the input policy.

If the tag already exists, this function replaces its current value with the new one.

If the tag identified by name does not exist, this function adds it to the tag set.

This function increases the maximum number of elements of the policy sequence by 10 when this number is not enough to store the new tag.

Precondition

policy, name and value cannot be null.

Parameters

policy	<<in>> Input policy.
name	<<in>> Tag name.
value	<<in>> Tag value.

Returns

One of the Standard Return Codes or DDS::Retcode_OutOfResources.

add_tag()

static void DDS::DataTagQosPolicyHelper::add_tag ( DataTagQosPolicy^  policy, String^  name, String^  value  )

static

Adds a new tag to the input policy.

This function will allocate memory to store the (name, value) pair. The memory allocated is owned by RTI Connext.

If the maximum number of elements of the policy sequence is not enough to store the new tag, this function will increase it by 10.

If the tag already exists, the function will fail with DDS::Retcode_PreconditionNotMet.

Precondition

policy, name and value cannot be null.

The tag is not in the policy.

Parameters

policy	<<in>> Input policy.
name	<<in>> Tag name.
value	<<in>> Tag value.

Returns

One of the Standard Return Codes or DDS::Retcode_OutOfResources or DDS::Retcode_PreconditionNotMet

lookup_tag()

static Tag ^ DDS::DataTagQosPolicyHelper::lookup_tag ( DataTagQosPolicy^  policy, String^  name  )

static

Searches by tag name for a tag in the input policy.

Precondition

policy, name and value cannot be null.

Parameters

policy	<<in>> Input policy.
name	<<in>> Tag name.

Returns

The function returns the first tag with the given name. If such a tag does not exist, the function returns NULL.

remove_tag()

static void DDS::DataTagQosPolicyHelper::remove_tag ( DataTagQosPolicy^  policy, String^  name  )

static

Removes a tag from the input policy.

If the tag does not exist, the function fails with DDS::Retcode_PreconditionNotMet.

Precondition

policy and name cannot be null.

The tag is in the policy.

Parameters

policy	<<in>> Input policy.
name	<<in>> Tag name.

Returns

One of the Standard Return Codes or DDS::Retcode_PreconditionNotMet.