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

Inheritance diagram for Topic:

Public Member Functions
void	get_inconsistent_topic_status (InconsistentTopicStatus status)
	Allows the application to retrieve the com.rti.dds.infrastructure.StatusKind.StatusKind.INCONSISTENT_TOPIC_STATUS status of a com.rti.dds.topic.Topic. More...

void	set_qos (TopicQos qos)
	Set the topic QoS. More...

void	set_qos_with_profile (String library_name, String profile_name)
	<<extension>> Change the QoS of this topic using the input XML QoS profile. More...

void	get_qos (TopicQos qos)
	Get the topic QoS. More...

void	set_listener (TopicListener l, int mask)
	Set the topic listener. More...

TopicListener	get_listener ()
	Get the topic listener. More...

Public Member Functions inherited from Entity
void	enable ()
	Enables the com.rti.dds.infrastructure.Entity. More...

StatusCondition	get_statuscondition ()
	Allows access to the com.rti.dds.infrastructure.StatusCondition associated with the com.rti.dds.infrastructure.Entity. More...

int	get_status_changes ()
	Retrieves the list of communication statuses in the com.rti.dds.infrastructure.Entity that are triggered. More...

InstanceHandle_t	get_instance_handle ()
	Allows access to the com.rti.dds.infrastructure.InstanceHandle_t associated with the com.rti.dds.infrastructure.Entity. More...

Public Member Functions inherited from TopicDescription
String	get_type_name ()
	Get the associated `type_name`. More...

String	get_name ()
	Get the name used to create this com.rti.dds.topic.TopicDescription . More...

DomainParticipant	get_participant ()
	Get the com.rti.dds.domain.DomainParticipant to which the com.rti.dds.topic.TopicDescription belongs. More...

Detailed Description

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

QoS:: com.rti.dds.topic.TopicQos

Status:: com.rti.dds.infrastructure.StatusKind.StatusKind.INCONSISTENT_TOPIC_STATUS, com.rti.dds.topic.InconsistentTopicStatus

Listener:: com.rti.dds.topic.TopicListener

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

com.rti.dds.topic.Topic is the only com.rti.dds.topic.TopicDescription that can be used for publications and therefore associated with a com.rti.dds.publication.DataWriter.

The following operations may be called even if the com.rti.dds.topic.Topic is not enabled. Other operations will fail with the value com.rti.dds.infrastructure.RETCODE_NOT_ENABLED if called on a disabled com.rti.dds.topic.Topic:

See also: Operations Allowed in Listener Callbacks

Member Function Documentation

◆ get_inconsistent_topic_status()

void get_inconsistent_topic_status ( InconsistentTopicStatus status )

Allows the application to retrieve the com.rti.dds.infrastructure.StatusKind.StatusKind.INCONSISTENT_TOPIC_STATUS status of a com.rti.dds.topic.Topic.

Retrieve the current com.rti.dds.topic.InconsistentTopicStatus

Parameters

status <<inout>> Status to be retrieved. Cannot be NULL.

Exceptions

One	of the Standard Return Codes

See also: com.rti.dds.topic.InconsistentTopicStatus

◆ set_qos()

void set_qos ( TopicQos qos )

Set the topic QoS.

The com.rti.dds.topic.TopicQos.topic_data and com.rti.dds.topic.TopicQos.deadline, com.rti.dds.topic.TopicQos.latency_budget, com.rti.dds.topic.TopicQos.transport_priority and com.rti.dds.topic.TopicQos.lifespan can be changed. The other policies are immutable.

Parameters

qos	<<in>> Set of policies to be applied to com.rti.dds.topic.Topic.

Policies must be consistent. Immutable policies cannot be changed after com.rti.dds.topic.Topic is enabled. The special value com.rti.dds.domain.DomainParticipant.TOPIC_QOS_DEFAULT can be used to indicate that the QoS of the com.rti.dds.topic.Topic should be changed to match the current default com.rti.dds.topic.TopicQos set in the com.rti.dds.domain.DomainParticipant. Cannot be NULL.

Exceptions

One	of the Standard Return Codes, com.rti.dds.infrastructure.RETCODE_IMMUTABLE_POLICY if immutable policy is changed, or com.rti.dds.infrastructure.RETCODE_INCONSISTENT_POLICY if policies are inconsistent

See also: com.rti.dds.topic.TopicQos for rules on consistency among QoS; set_qos (abstract); Operations Allowed in Listener Callbacks

◆ set_qos_with_profile()

void set_qos_with_profile	(	String	library_name,
		String	profile_name
	)

<<extension>> Change the QoS of this topic using the input XML QoS profile.

The com.rti.dds.topic.TopicQos.topic_data and com.rti.dds.topic.TopicQos.deadline, com.rti.dds.topic.TopicQos.latency_budget, com.rti.dds.topic.TopicQos.transport_priority and com.rti.dds.topic.TopicQos.lifespan can be changed. The other policies are immutable.

Parameters

library_name	<<in>> Library name containing the XML QoS profile. If library_name is null RTI Connext will use the default library (see com.rti.dds.domain.DomainParticipant.set_default_library).
profile_name	<<in>> XML QoS Profile name. If profile_name is null RTI Connext will use the default profile (see com.rti.dds.domain.DomainParticipant.set_default_profile).

Exceptions

One	of the Standard Return Codes, com.rti.dds.infrastructure.RETCODE_IMMUTABLE_POLICY if immutable policy is changed, or com.rti.dds.infrastructure.RETCODE_INCONSISTENT_POLICY if policies are inconsistent

See also: com.rti.dds.topic.TopicQos for rules on consistency among QoS; Operations Allowed in Listener Callbacks

◆ get_qos()

void get_qos ( TopicQos qos )

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. Cannot be NULL.

Exceptions

One	of the Standard Return Codes

See also: get_qos (abstract)

◆ set_listener()

void set_listener	(	TopicListener	l,
		int	mask
	)

Set the topic listener.

Parameters

l	<<in>> Listener to be installed on entity.
mask	<<in>> Changes of communication status to be invoked on the listener. See com.rti.dds.infrastructure.StatusMask.

Exceptions

One	of the Standard Return Codes

See also: set_listener (abstract)

◆ get_listener()

TopicListener get_listener ( )

Get the topic listener.

Returns: Existing listener attached to the com.rti.dds.topic.Topic.

See also: get_listener (abstract)

Public Member Functions

Detailed Description

Member Function Documentation

◆ get_inconsistent_topic_status()

◆ set_qos()

◆ set_qos_with_profile()

◆ get_qos()

◆ set_listener()

◆ get_listener()