DDSTopic Class Reference

<<interface>> The most basic description of the data to be published and subscribed. More...

Inheritance diagram for DDSTopic:

List of all members.

Public Member Functions
virtual DDSTopicDescription *	as_topicdescription ()=0
	<<cert>> Access a DDSTopic's DDSTopicDescription supertype instance.
virtual DDSEntity *	as_entity ()=0
	<<cert>> Access a DDSTopic's DDSEntity supertype instance.
virtual DDS_ReturnCode_t	set_qos (const DDS_TopicQos &qos)=0
	Set the topic QoS.
virtual DDS_ReturnCode_t	get_qos (DDS_TopicQos &qos)=0
	Get the topic QoS.
virtual DDS_ReturnCode_t	get_inconsistent_topic_status (DDS_InconsistentTopicStatus &status)=0
	<<cert>> Allows the application to retrieve the DDS_INCONSISTENT_TOPIC_STATUS status of a DDSTopic.
virtual DDS_ReturnCode_t	set_listener (const DDSTopicListener *listener, DDS_StatusMask mask)=0
	Set the topic listener.
virtual DDSTopicListener *	get_listener ()=0
	Get the topic listener.
virtual const char *	get_type_name ()=0
	<<cert>> Get the associated type_name.
virtual const char *	get_name ()=0
	<<cert>> Get the name used to create this DDSTopicDescription.
virtual DDSDomainParticipant *	get_participant ()=0
	<<cert>> Get the DDSDomainParticipant to which the DDSTopicDescription belongs.
Public Member Functions inherited from DDSEntity
DDS_ReturnCode_t	enable ()
	<<cert>> Enables the DDSEntity.
DDSStatusCondition *	get_statuscondition ()
	<<cert>> Return the DDSStatusCondition associated with a particular DDSEntity.
DDS_StatusMask	get_status_changes ()
	<<cert>> Retrieves the list of communication statuses in the DDSEntity that are triggered.
DDS_InstanceHandle_t	get_instance_handle ()
	<<cert>> Allows access to the DDS_InstanceHandle_t associated with the DDSEntity.

Static Public Member Functions
static DDSTopic *	narrow (DDSTopicDescription *topic_description)
	<<cert>> Narrow the given DDSTopicDescription pointer to a DDSTopic pointer.

---

Detailed Description

<<interface>> The most basic description of the data to be published and subscribed.

QoS:

DDS_TopicQos

Status:

DDS_INCONSISTENT_TOPIC_STATUS, DDS_InconsistentTopicStatus

Listener:

DDSTopicListener

A DDSTopic is identified by its name, which must be unique in the whole domain. In addition (by virtue of extending DDSTopicDescription) it fully specifies the type of the data that can be communicated when publishing or subscribing to the DDSTopic.

DDSTopic is the only DDSTopicDescription that can be used for publications and therefore associated with a DDSDataWriter.

The following operations may be called even if the DDSTopic is not enabled. Other operations will fail with the value DDS_RETCODE_NOT_ENABLED if called on a disabled DDSTopic:

• get_inconsistent_topic_status()

---

Member Function Documentation

static DDSTopic* DDSTopic::narrow ( DDSTopicDescription *  topic_description )

static

<<cert>> Narrow the given DDSTopicDescription pointer to a DDSTopic pointer.

Returns:

DDSTopic if this DDSTopicDescription is a DDSTopic. Otherwise, return NULL.

virtual DDSTopicDescription* DDSTopic::as_topicdescription ( )

pure virtual

<<cert>> Access a DDSTopic's DDSTopicDescription supertype instance.

Returns:

DDSTopic's supertype DDSTopicDescription instance

virtual DDSEntity* DDSTopic::as_entity ( )

pure virtual

<<cert>> Access a DDSTopic's DDSEntity supertype instance.

Returns:

DDSTopic's supertype DDSEntity instance

virtual DDS_ReturnCode_t DDSTopic::set_qos ( const DDS_TopicQos &  qos )

pure virtual

Set the topic QoS.

Parameters:

qos	<<in>> Set of policies to be applied to DDSTopic.

Policies must be consistent. Policies cannot be changed after DDSTopic is enabled. The special value DDS_TOPIC_QOS_DEFAULT can be used to indicate that the QoS of the DDSTopic should be changed to match the current default DDS_TopicQos set in the DDSDomainParticipant.

Returns:

One of the Standard Return Codes, DDS_RETCODE_IMMUTABLE_POLICY if immutable policy is changed, or DDS_RETCODE_INCONSISTENT_POLICY if policies are inconsistent

See also:

DDS_TopicQos for rules on consistency among QoS

set_qos (abstract)

virtual DDS_ReturnCode_t DDSTopic::get_qos ( DDS_TopicQos &  qos )

pure virtual

Get the topic QoS.

This method may potentially allocate memory depending on the sequences contained in some QoS policies.

Parameters:

qos	<<inout>> QoS to be filled up.

Returns:

One of the Standard Return Codes

See also:

get_qos (abstract)

virtual DDS_ReturnCode_t DDSTopic::get_inconsistent_topic_status ( DDS_InconsistentTopicStatus &  status )

pure virtual

<<cert>> Allows the application to retrieve the DDS_INCONSISTENT_TOPIC_STATUS status of a DDSTopic.

Retrieve the current DDS_InconsistentTopicStatus

Parameters:

status

<<inout>> Status to be retrieved.

Returns:

One of the Standard Return Codes

MT Safety:

This operation is thread safe. However, note that the arguments are not protected from being modified by other threads and must not be modified until the call returns.

See also:

DDS_InconsistentTopicStatus

virtual DDS_ReturnCode_t DDSTopic::set_listener ( const DDSTopicListener *  listener, DDS_StatusMask  mask  )

pure virtual

Set the topic listener.

Parameters:

listener	<<in>> Listener to be installed on entity.
mask	<<in>> Changes of communication status to be invoked on the listener.

Returns:

One of the Standard Return Codes

virtual DDSTopicListener* DDSTopic::get_listener ( )

pure virtual

Get the topic listener.

Returns:

Existing listener attached to the DDSTopic.

virtual const char* DDSTopic::get_type_name ( )

pure virtual

<<cert>> Get the associated type_name.

The type name defines a locally unique type for the publication or the subscription.

The type_name corresponds to a unique string used to register a type via the DDSDomainParticipant::register_type method.

Thus, the type_name implies an association with a corresponding type and this DDSTopicDescription.

Returns:

the type name. The returned type name is valid until the DDSTopicDescription is deleted.

MT Safety:

This operation is thread safe.

Postcondition:

The result is NULL if self is NULL, otherwise result is non-NULL.

Implements DDSTopicDescription.

virtual const char* DDSTopic::get_name ( )

pure virtual

<<cert>> Get the name used to create this DDSTopicDescription.

Returns:

the name used to create this DDSTopicDescription. The returned topic name is valid until the DDSTopicDescription is deleted.

MT Safety:

This operation is thread safe.

Postcondition:

The result is NULL if self is NULL, otherwise result is non-NULL.

Implements DDSTopicDescription.

virtual DDSDomainParticipant* DDSTopic::get_participant ( )

pure virtual

<<cert>> Get the DDSDomainParticipant to which the DDSTopicDescription belongs.

Returns:

The DDSDomainParticipant to which the DDSTopicDescription belongs.

MT Safety:

This operation is thread safe.

Postcondition:

TThe result is NULL if self is NULL, otherwise result is non-NULL.

Implements DDSTopicDescription.