DDS Namespace Reference

Provides the DDS infrastructure. More...

Namespaces
	rpc
	Provides the RPC over DDS infrastructure.

Classes
class	AnnotationDescriptor
	A AnnotationDescriptor object comprises the state of an annotation as it is applied to some element. More...
struct	BuiltinTopicKey_t
class	Condition
	A Condition can be added to a WaitSet to provide synchronous event notification. More...
class	ContentFilteredTopic
	ContentFilteredTopic provides a topic that may exclude data based on a specified filter. The ContentFilteredTopic is associated with another un-filtered topic related_topic. It applies a filter to the data of the related topic. If a data sample passes the filter, it will be made available to a DataReader associated with the ContentFilteredTopic. More...
class	DataReader
	The DataReader entity allows the application to subscribe to and read data. More...
class	DataReaderListener
	The DataReaderListener provides asynchronous notification of DataReader events. More...
class	DataReaderQos
	Structure that holds DataReader Quality of Service policies. More...
struct	DataRepresentationQosPolicy
	Describes the data representation used by a topic. More...
class	DataWriter
	The DataWriter entity provides an interface for the application to publish (write) data. More...
class	DataWriterListener
	The DataWriterListener provides asynchronous notification of DataWriter events. More...
class	DataWriterQos
	Structure that holds DataWriter Quality of Service policies. More...
struct	DCPSParticipant
struct	DCPSPublication
struct	DCPSSubscription
struct	DeadlineQosPolicy
	This QoS policy establishes a minimum update period for data instances. More...
struct	DestinationOrderQosPolicy
	This QoS policy controls how each Subscriber orders received data samples. More...
class	DomainEntity
	Base class for all DDS Domain Entities. More...
class	DomainParticipant
	The DomainParticipant is used to configure, create and destroy Publisher, Subscriber and Topic objects. More...
class	DomainParticipantFactory
	DomainParticipantFactory constructs DomainParticipants. The. More...
class	DomainParticipantFactoryQos
	Structure that holds DomainParticipantFactory Quality of Service policies. More...
class	DomainParticipantListener
	The DomainParticipantListener provides asynchronous notification of DomainParticipant events. More...
class	DomainParticipantQos
	Structure that holds DomainParticipant Quality of Service policies. More...
struct	DurabilityQosPolicy
	The DurabilityQosPolicy controls the durablity of data. More...
struct	DurabilityServiceQosPolicy
struct	Duration_t
	The Duration_t structure contains data to define a time duration. More...
class	DynamicData
	A DynamicData object represents an individual data sample. It provides reflective getters and setters for the members of that sample. More...
class	DynamicDataFactory
	This type is responsible for creating DynamicData instances. More...
class	DynamicDataReader
	Provides a DataReader interface that is tailored to support reading an X-Types defined DynamicData data type. The specific DynamicType must have been registered previously with the DomainParticipant. More...
class	DynamicDataWriter
	A DataWriter that writes 'DynamicData' data elements. Data written by this DataWriter can be read by a standard DataReader or by a DynamicDataReader, if the QoS and data types match. More...
class	DynamicType
	An instance of DynamicType represent a type’s schema: its physical name, kind, member definitions (if any), and so on. More...
class	DynamicTypeBuilder
	A DynamicTypeBuilder object represents the state of a particular type defined according to the Type System. It is used to instantiate concrete DynamicType objects. More...
class	DynamicTypeBuilderFactory
	An instance of this type is responsible for creating DynamicType and DynamicTypeSupport objects. More...
class	DynamicTypeMember
	A DynamicTypeMember represents a "member" of a type. A "member" in this sense may be a member of an aggregated type, a constant within an enumeration, or some other type substructure. More...
class	DynamicTypeSupport
	The DynamicTypeSupport interface extends the TypeSupport interface defined by the DDS specification. This TypeSupport operates on DynamicData samples. More...
class	Entity
	Base class for all DDS Entities. More...
struct	GroupDataQosPolicy
	Allows the application to attach arbitrary information to a Publisher or Subscriber. More...
class	GuardCondition
	A GuardCondition is a condition where the trigger_value is under application control. More...
struct	GUID_t
struct	HistoryQosPolicy
	Controls the ammount of historical data maintained by a DataReader or DataWriter. More...
struct	LatencyBudgetQosPolicy
	Specifies allowable latency. More...
struct	LifespanQosPolicy
	Specifies the maximum duration of validity of the data written by the DataWriter. More...
struct	LivelinessQosPolicy
	Determines the mechanism and parameters used by the application to determine whether an Entity is alive. More...
class	LoanedSamples
	Holds a collection of sample data and related meta-data. More...
class	MemberDescriptor
	A MemberDescriptor comprises the state of a DynamicTypeMember. More...
struct	OwnershipQosPolicy
	Determines instance ownership in the case of multple writers. CoreDX DDS supports both SHARED_OWNERSHIP_QOS and EXCLUSIVE_OWNERSHIP_QOS. More...
struct	OwnershipStrengthQosPolicy
	Defines the strength, or priority, of a Writer. The strength is used to determine ownership in the case of EXCLUSIVE_OWNERSHIP_QOS. When multiple writers publish data about the same instance, the stronger writer is considered the owner, and data from other writers is not delivered to the reader. More...
struct	PartitionQosPolicy
	Defines a logical data partition. More...
struct	PresentationQosPolicy
	Controls the presentation of received data samples to the application. CoreDX DDS currently supports only the access_scope = INSTANCE_PRESENTATION_QOS policy. More...
struct	Property_t
	A name-value pair property. The 'propagate' flag indicates if this property should be transfered through discovery. More...
struct	PropertyQosPolicy
class	Publisher
	The Publisher configures, creates, manages and destroys DataWriters. More...
class	PublisherListener
	The PublisherListener provides asynchronous notification of Publisher events. More...
class	PublisherQos
	Structure that holds Publisher Quality of Service policies. More...
class	QosProvider
	QosProvider loads QoS settings from a library and provides interfaces to access entity specific QoS Policies. More...
class	QueryCondition
	A QueryCondition is a specialized ReadCondition which includes a filter. More...
class	ReadCondition
	A ReadCondition is a specialized Condition associated with a DataReader. More...
struct	ReliabilityQosPolicy
	Indicates the level of reliability offered/provided by the Entity. If kind is RELIABLE_RELIABILITY_QOS, then the middleware will attempt to deliver all samples in the history cache. If samples are not received, then they will be retried. More...
struct	ResourceLimitsQosPolicy
	Specifies the resources that the Service can use to maintain data samples and instances. More...
struct	RpcQosPolicy
	Augment a DataWriter or DataReader with RPC specific information. More...
class	Sample
	Sample holds the data and related meta information. More...
struct	SampleIdentity_t
class	SampleIterator
	Provides a means to iterate over a collection of Samples. More...
class	SampleRef
	SampleRef holds a reference to data and related meta information. More...
class	sequence
	Sequence data type. More...
struct	SequenceNumber_t
class	SharedSamples
	Holds a reference to a collection of sample data and related meta-data. More...
class	StatusCondition
	A StatusCondition is a condition associated with an Entity. More...
class	Subscriber
	The Subscriber configures, creates, manages and destroys DataReaders. More...
class	SubscriberListener
	The SubscriberListener provides asynchronous notification of Subscriber events. More...
class	SubscriberQos
	Structure that holds Subscriber Quality of Service policies. More...
struct	Time_t
	The Time_t structure contains data to define a time. More...
struct	TimeBasedFilterQosPolicy
	Defines a filter based on time between samples. The DataReader indicates that it wants at most one sample for each instance every minimum_separation interval. More...
class	Topic
	Topic is the basic description of data to be published or subscribed. More...
struct	TopicDataQosPolicy
	Allows the application to attach arbitrary information to a Topic QoS. More...
class	TopicDescription
	TopicDescription is an abstract 'class' that provides the foundation for Topic, ContentFilteredTopic, and MultiTopic. More...
class	TopicListener
	The TopicListener provides asynchronous notification of Topic events. More...
class	TopicQos
	Structure that holds Topic Quality of Service policies. More...
struct	TransportPriorityQosPolicy
	A hint to the middleware to help configure the transport priority mechanism. More...
struct	TypecodeQosPolicy
	Typecode representing the datatype a DataReader reads or a DataWriter writes. More...
struct	TypeConsistencyEnforcementQosPolicy
	rules for determining type consistency More...
class	TypeDescriptor
	A TypeDescriptor comprises the state of a type. More...
struct	UserDataQosPolicy
	Allows the application to attach arbitrary information to a DomainParticipant, DataWriter or DataReader QoS. More...
class	WaitSet
	A WaitSet maintains a set of Condition objects and allows the application to wait until one or more of them have a trigger_value of TRUE. More...
class	WriteSample
	Holds sample data intended for transmission. More...
class	WriteSampleRef
	Holds a reference to sample data intended for transmission. More...

Typedefs
typedef unsigned char	GuidPrefix_t[12]
typedef short	DataRepresentationId_t
	Indicates the form of data, for example CDR or XML.
typedef DDS_DOMAINID_TYPE_NATIVE	DomainId_t
typedef DDS_HANDLE_TYPE_NATIVE	InstanceHandle_t
typedef long	ReturnCode_t
typedef unsigned long	StatusMask
typedef DDS::sequence< SampleInfo * >	SampleInfoSeq
	sequence of SampleInfo pointers
typedef DDS::sequence< DataReader * >	DataReaderSeq
	sequence of DataReader pointers
typedef DDS::sequence< InstanceHandle_t >	InstanceHandleSeq
	sequence of InstanceHandle_t s
typedef DDS::sequence< Condition * >	ConditionSeq
	sequence of Condition pointers
typedef DDS::sequence< void * >	Sequence
	sequence of void pointers
typedef DDS::sequence< char * >	StringSeq
	sequence of character pointers (c strings)
typedef DDS::sequence< unsigned char >	OctetSeq
	sequence of octets

Enumerations

Functions
DDS::TypeObject *	TypecodeQosPolicy_to_typeobject (TypecodeQosPolicy *tc_qos)
	Helper function to get DDS::TypeObject from a discovered (or otherwise obtained) TypeCode byte buffer.

Detailed Description

Provides the DDS infrastructure.

namespace DDS

Typedef Documentation

typedef DDS_DOMAINID_TYPE_NATIVE DDS::DomainId_t

Identifies the domain

typedef unsigned char DDS::GuidPrefix_t[12]

Another form of builtin topic key (12 bytes).

typedef DDS_HANDLE_TYPE_NATIVE DDS::InstanceHandle_t

Identifies a data instance within the scope of a specific Entity.

typedef long DDS::ReturnCode_t

Indicates success or failure of an API operation.

typedef unsigned long DDS::StatusMask

A set of bits that select a set of statuses.

Enumeration Type Documentation

enum DDS::DestinationOrderQosPolicyKind

This enumeration contains the kinds of Destination Ordering.

Enumerator
BY_RECEPTION_TIMESTAMP_DESTINATIONORDER_QOS	Use the reception time to determine the order of samples.
BY_SOURCE_TIMESTAMP_DESTINATIONORDER_QOS	Use the timestamp set by the publisher to determine the order of samples.

enum DDS::DiscoveryQosPolicyDiscoveryKind

This enumeration contains the kinds of Discovery.

Enumerator
PEER_DISCOVERY_QOS	The DomainParticipant will use the standard peer-to-peer discovery.
CENTRAL_DISCOVERY_QOS	The DomainParticipant will connect to the CoreDX DDS CDD for discovery.

enum DDS::DurabilityQosPolicyKind

This enumeration contains the kinds of Durability.

Enumerator
VOLATILE_DURABILITY_QOS	The data is volatile, and is not persisted beyond the initial publication.
TRANSIENT_LOCAL_DURABILITY_QOS	The data is persisted locally within the source DataWriter.
TRANSIENT_DURABILITY_QOS	The data is persisted beyond the lifecycle of the originating DataWriter, and is available even after that DataWriter has been destroyed.
PERSISTENT_DURABILITY_QOS	The data is persisted to 'off-line' storage, and is available even after a system reboot.

enum DDS::HistoryQosPolicyKind

This enumeration contains the kinds of History.

Enumerator
KEEP_LAST_HISTORY_QOS	Store at most depth Samples in the data cache for each Instance. Samples may be overwritten.
KEEP_ALL_HISTORY_QOS	Store Samples for each Instance (up to the limits specified by ResourceLimitsQosPolicy) until the DDS infrastructure is finished with them. Until this time, Samples may not be overwritten.

enum DDS::LivelinessQosPolicyKind

This enumeration contains the kinds of Liveliness.

Enumerator
AUTOMATIC_LIVELINESS_QOS	The DomainParticipant automatically asserts liveliness for all DataWriters within the DomainParticipant.
MANUAL_BY_PARTICIPANT_LIVELINESS_QOS	The application manually asserts the liveliness all DataWriters within this DomainParticipant by calling assert_liveliness() or writing data on any one DataWriter within this DomainParticipant.
MANUAL_BY_TOPIC_LIVELINESS_QOS	The application manually asserts the liveliness for each individual DataWriter by calling assert_liveliness() or writing data on that DataWriter.

enum DDS::OwnershipQosPolicyKind

This enumeration contains the kinds of Ownership.

Enumerator
SHARED_OWNERSHIP_QOS	DataReaders receive data published by multiple DataWriters.
EXCLUSIVE_OWNERSHIP_QOS	DataReaders receive data published by the highest strength DataWriter for each Instance.

enum DDS::PresentationQosPolicyAccessScopeKind

This enumeration contains the kinds of Access Scope for the PresentationQosPolicy.

Enumerator
INSTANCE_PRESENTATION_QOS	The scope is within an Instance.
TOPIC_PRESENTATION_QOS	The scope is within samples published by DataWriters on the Topic.
GROUP_PRESENTATION_QOS	The scope is within samples published by DataWriters within the Publisher.

enum DDS::ReliabilityQosPolicyKind

This enumeration contains the kinds of Reliability.

Enumerator
BEST_EFFORT_RELIABILITY_QOS	Best effort delivery – NO retransmission, HB, or ACKNACK.
RELIABLE_RELIABILITY_QOS	Reliable delivery – HB, ACKNACK, and re-transmission.

enum DDS::TypeConsistencyKind

the allowed kinds of TypeConsistency

Enumerator
DISALLOW_TYPE_COERCION	disallow coercion (type name and structure must match)
ALLOW_TYPE_COERCION	allow coercion