rti::config::activity_context::AttributeKindMask Class Reference

The attributes used in the string representation of the Activity Context can be configured through this mask. More...

#include <ActivityContext.hpp>

Inherits bitset< 32 >.

Public Types
typedef std::bitset< 32 >	MaskType
	A typedef of std::bitset<32> for convenience. More...

Public Member Functions
	AttributeKindMask ()
	Not provide any attribute of the resource of the Activity Context. More...
	AttributeKindMask (uint64_t mask)
	Construct a AttributeKindMask from an integer. More...
	AttributeKindMask (const MaskType &mask)
	Construct a AttributeKindMask from a MaskType object. More...

Static Public Member Functions
static const AttributeKindMask	guid_prefix ()
	Provide the entity GUID prefix to the resource of the Activity Context. More...
static const AttributeKindMask	topic ()
	Provide the Topic to the resource of the Activity Context. The topic attribute is specified by "T". More...
static const AttributeKindMask	type ()
	Provide the data type to the resource of the Activity Context. The type attribute is specified by "C". More...
static const AttributeKindMask	entity_kind ()
	Provide the entity kind to the resource of the Activity Context. The kind attribute is specified by "E". More...
static const AttributeKindMask	domain_id ()
	Provide the domain ID to the resource of the Activity Context. The domain attribute is specified by "D". More...
static const AttributeKindMask	entity_name ()
	Provide the entity name to the resource of the Activity Context. The name attribute is specified by "N". More...
static const AttributeKindMask	default_mask ()
	Provide the default attributes of the resource of the Activity Context. More...
static const AttributeKindMask	none ()
	Not provide any attribute of the resource of the Activity Context. More...
static const AttributeKindMask	all ()
	Provide all the possibles attributes of the resource of the Activity Context. More...

Detailed Description

The attributes used in the string representation of the Activity Context can be configured through this mask.

This mask indicates what attributes of the resource are used when RTI Connext logs a message or when the Heap Monitoring utility saves statistics for a memory allocation.

Member Typedef Documentation

MaskType

typedef std::bitset<32> rti::config::activity_context::AttributeKindMask::MaskType

A typedef of std::bitset<32> for convenience.

Constructor & Destructor Documentation

AttributeKindMask() [1/3]

rti::config::activity_context::AttributeKindMask::AttributeKindMask ( )

inline

Not provide any attribute of the resource of the Activity Context.

AttributeKindMask() [2/3]

rti::config::activity_context::AttributeKindMask::AttributeKindMask ( uint64_t  mask )

inlineexplicit

Construct a AttributeKindMask from an integer.

Parameters

mask	Value whose bits are copied to the bitset positions

AttributeKindMask() [3/3]

rti::config::activity_context::AttributeKindMask::AttributeKindMask ( const MaskType &  mask )

inline

Construct a AttributeKindMask from a MaskType object.

Parameters

mask	A std::bitset<32> to construct this AttributeKindMask from

Member Function Documentation

guid_prefix()

static const AttributeKindMask rti::config::activity_context::AttributeKindMask::guid_prefix ( )

inlinestatic

Provide the entity GUID prefix to the resource of the Activity Context.

For example:

• For the following string representation of the context:

  [0X101A76B,0X79E5D71,0X50EE914:0X1C1:0X80000003{N=testDataWriterName,E=DW,T=test,C=Foo,D=1}|Write]                     

• The GUID prefix is 0X101A76B,0X79E5D71,0X50EE914. If the bit ActivityContextAttributeKind::GUID_PREFIX is not set, the string representation will not show the GUID prefix:

  [:0X80000003{N=testDataWriterName,E=DW,T=test,C=Foo,D=1}|Write]                     

topic()

static const AttributeKindMask rti::config::activity_context::AttributeKindMask::topic ( )

inlinestatic

Provide the Topic to the resource of the Activity Context. The topic attribute is specified by "T".

For example:

• For the following string representation of the context:

  [0X101A76B,0X79E5D71,0X50EE914:0X1C1:0X80000003{N=testDataWriterName,E=DW,T=test,C=Foo,D=1}|Write]                     

• The Topic (T) is "test." If the bit ActivityContextAttributeKind::TOPIC is not set, the string representation will not show the Topic (T):

  [0X101A76B,0X79E5D71,0X50EE914:0X1C1:0X80000003{N=testDataWriterName,E=DW,C=Foo,D=1}|Write]                     

type()

static const AttributeKindMask rti::config::activity_context::AttributeKindMask::type ( )

inlinestatic

Provide the data type to the resource of the Activity Context. The type attribute is specified by "C".

For example:

• For the following string representation of the context:

  [0X101A76B,0X79E5D71,0X50EE914:0X1C1:0X80000003{N=testDataWriterName,E=DW,T=test,C=Foo,D=1}|Write]                     

• The data type (C) is "Foo." If the bit ActivityContextAttributeKind::TYPE is not set, the string representation will not show the data type (C):

  [0X101A76B,0X79E5D71,0X50EE914:0X1C1:0X80000003{N=testDataWriterName,E=DW,T=test,D=1}|Write]                     

entity_kind()

static const AttributeKindMask rti::config::activity_context::AttributeKindMask::entity_kind ( )

inlinestatic

Provide the entity kind to the resource of the Activity Context. The kind attribute is specified by "E".

For example:

• For the following string representation of the context:

  [0X101A76B,0X79E5D71,0X50EE914:0X1C1:0X80000003{N=testDataWriterName,E=DW,T=test,C=Foo,D=1}|Write]                     

• The entity kind (E) is "Writer." If the bit ActivityContextAttributeKind::ENTITY_KIND is not set, the string representation will not show the entity kind (E):

  [0X101A76B,0X79E5D71,0X50EE914:0X1C1:0X80000003{N=testDataWriterName,T=test,C=Foo,D=1}|Write]                     

domain_id()

static const AttributeKindMask rti::config::activity_context::AttributeKindMask::domain_id ( )

inlinestatic

Provide the domain ID to the resource of the Activity Context. The domain attribute is specified by "D".

For example:

• For the following string representation of the context:

  [0X101A76B,0X79E5D71,0X50EE914:0X1C1:0X80000003{N=testDataWriterName,E=DW,T=test,C=Foo,D=1}|Write]                     

• The domain ID (D) is "1." If the bit ActivityContextAttributeKind::DOMAIN_ID is not set, the string representation will not show the domain ID (D):

  [0X101A76B,0X79E5D71,0X50EE914:0X1C1:0X80000003{N=testDataWriterName,E=DW,T=test,C=Foo}|Write]                     

entity_name()

static const AttributeKindMask rti::config::activity_context::AttributeKindMask::entity_name ( )

inlinestatic

Provide the entity name to the resource of the Activity Context. The name attribute is specified by "N".

For example:

• For the following string representation of the context:

  [0X101A76B,0X79E5D71,0X50EE914:0X1C1:0X80000003{N=testDataWriterName,E=DW,T=test,C=Foo,D=1}|Write]                     

• The entity name (N) is "testDataWriterName." If the bit ActivityContextAttributeKind::ENTITY_NAME is not set, the string representation will not show the entity name (N):

  [0X101A76B,0X79E5D71,0X50EE914:0X1C1:0X80000003{E=DW,T=test,C=Foo,D=1}|Write]                     

default_mask()

static const AttributeKindMask rti::config::activity_context::AttributeKindMask::default_mask ( )

inlinestatic

Provide the default attributes of the resource of the Activity Context.

none()

static const AttributeKindMask rti::config::activity_context::AttributeKindMask::none ( )

inlinestatic

Not provide any attribute of the resource of the Activity Context.

all()

static const AttributeKindMask rti::config::activity_context::AttributeKindMask::all ( )

inlinestatic

Provide all the possibles attributes of the resource of the Activity Context.

References rti::config::activity_context::set_attribute_mask().