CoreDX DDS
C# Reference Manual

Class List

Here are the classes, structs, unions and interfaces with brief descriptions:
ConditionA Condition can be added to a WaitSet to provide synchronous event notification
ContentFilteredTopicContentFilteredTopic provides a topic that may include data filtered from a related Topic. 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
DataReaderThe DataReader entity allows the application to subscribe to and read data
DataReaderListenerThe DataReaderListener provides asynchronous notification of DataReader events
DataReaderQosStructure that holds DataReader Quality of Service policies
DataWriterThe DataWriter entity provides an interface for the application to publish (write) data. The DataWriter is an abstract class that is extended to support a particular data type required by the application. A DataReader is associated with, and writes on, a single Topic
DataWriterListenerThe DataWriterListener provides asynchronous notification of DataWriter events
DataWriterQosStructure that holds DataWriter Quality of Service policies
DDSThe 'DDS' class includes several convient constants
DDS_MultiTopicDDS_MultiTopic provides a topic that may include data from multiple Topics
DeadlineQosPolicyThis QoS policy establishes a minimum update period for data instances
DestinationOrderQosPolicyThis QoS policy controls how each Subscriber orders received data samples
DomainEntityBase class for all DDS Domain Entities
DomainParticipantThe DomainParticipant is used to configure, create and destroy Publisher, Subscriber and Topic objects
DomainParticipantFactoryDomainParticipantFactory constructs DomainParticipants. The
DomainParticipantFactoryQosStructure that holds DomainParticipantFactory Quality of Service policies
DomainParticipantListenerThe DomainParticipantListener provides asynchronous notification of DomainParticipant events
DomainParticipantQosStructure that holds DomainParticipant Quality of Service policies
DurabilityQosPolicy
DurabilityServiceQosPolicy
Duration_tDuration_t is used to indicate a duration of time
EntityBase class for all DDS Entities
EntityFactoryQosPolicy
GroupDataQosPolicyAllows the application to attach arbitrary information to a Publisher or Subscriber
GuardConditionA GuardCondition is a Condition where the trigger_value is under application control
HistoryQosPolicyControls the ammount of historical data maintained by a DataReader or DataWriter
InconsistentTopicStatusStatus related to the on_inconsistent_topic listener methods of the TopicListener structure
LatencyBudgetQosPolicySpecifies allowable latency
LifespanQosPolicySpecifies the maximum duration of validity of the data written by the DataWriter
LivelinessChangedStatusStatus related to the on_liveliness_changed listener methods of the DataReader, Subscriber, and DomainParticipant structures
LivelinessLostStatusStatus related to the on_liveliness_lost listener methods of the DataWriter, Publisher, and DomainParticipant structures
LivelinessQosPolicyDetermines the mechanism and parameters used by the application to determine whether an Entity is alive
OfferedDeadlineMissedStatusStatus related to the on_offered_deadline_missed listener methods of the DataWriter, Publisher, and DomainParticipant structures
OfferedIncompatibleQosStatusStatus related to the on_offered_incompatible_qos listener methods of the DataWriter, Publisher, and DomainParticipant structures
OwnershipQosPolicyDetermines instance ownership in the case of multple writers. CoreDX DDS supports both SHARED_OWNERSHIP_QOS and EXCLUSIVE_OWNERSHIP_QOS
OwnershipStrengthQosPolicyDefines 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
PartitionQosPolicy
PresentationQosPolicyControls the presentation of received data samples to the application. CoreDX DDS currently supports only the access_scope = INSTANCE_PRESENTATION_QOS policy
PublicationMatchedStatusStatus related to the on_publication_matched listener methods of the DataWriter, Publisher, and DomainParticipant structures
PublisherThe Publisher configures, creates, manages and destroys DataWriters
PublisherListenerThe PublisherListener provides asynchronous notification of Publisher events
PublisherQosStructure that holds Publisher Quality of Service policies
QueryConditionThe trigger_value is driven by the data available, after applying the filter, in the associated DataReader
ReadConditionA ReadCondition is a specialized Condition associated with a DataReader
ReaderDataLifecycleQosPolicySpecifies the lifecycle behavior of data instances managed by the DataReader
ReliabilityQosPolicyIndicates 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
RequestedDeadlineMissedStatusStatus related to the on_requested_deadline_missed listener methods of the DataReader, Subscriber, and DomainParticipant structures
RequestedIncompatibleQosStatusStatus related to the on_requested_incompatible_qos listener methods of the DataReader, Subscriber, and DomainParticipant structures
ResourceLimitsQosPolicySpecifies the resources that the Service can use to maintain data samples and instances
RTPSReaderQosPolicy
RTPSWriterQosPolicy
SampleInfoThe SampleInfo structure contains information associated with each Sample. The DataReader.read() and take() operations return two vectors. One vector contains Sample(s) and the other contains SampleInfo(s). There is a one-to-one correspondence between items in these two vectors. Each Sample is described by the corresponding SampleInfo instance
SampleLostStatusStatus related to the on_sample_lost listener methods of the DataReader, Subscriber, and DomainParticipant structures
SampleRejectedStatusStatus related to the on_sample_rejected listener methods of the DataReader, Subscriber, and DomainParticipant structures
StatusConditionA StatusCondition is a condition associated with an Entity. The trigger_value is driven by the communication status of the associated Entity
SubscriberThe Subscriber configures, creates, manages and destroys DataReaders
SubscriberListenerThe SubscriberListener provides asynchronous notification of Subscriber events
SubscriberQosStructure that holds DDS_Subscriber Quality of Service policies
SubscriptionMatchedStatusStatus related to the on_subscription_matched listener methods of the DataReader, Subscriber, and DomainParticipant structures
Time_tTime_t is used to specify an point in time
TimeBasedFilterQosPolicyDefines a filter based on time between samples. The DataReader indicates that it wants at most one sample for each instance every minimum_separation interval
TopicTopic is the basic description of data to be published or subscribed. A topic is identified by a name and a type. A Topic is created by calling DomainParticipant.create_topic(). Prior to creating a Topic, the associated data type must be registered with the DomainParticipant via a call to the TypeSupportXYZ.register_type() function. [The register_type() function is auto-generated 'type-specific' code.]
TopicDataQosPolicyAllows the application to attach arbitrary information to a Topic QoS
TopicDescriptionTopicDescription is an interface that provides the foundation for Topic, ContentFilteredTopic, and MultiTopic
TopicListenerThe TopicListener provides asynchronous notification of Topic events
TopicQosStructure that holds DDS_Topic Quality of Service policies
TransportPriorityQosPolicyA hint to the middleware to help configure the transport priority mechanism
UserDataQosPolicyAllows the application to attach arbitrary information to a DomainParticipant, DataWriter or DataReader
WaitSetA DDS_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
WriterDataLifecycleQosPolicySpecifies the lifecycle behavior of data instances managed by the DataWriter. If autodispose_unregistered_instances is true, then the DataWriter will automatically dispose any instances that are unregistered. Note: When a DataWriter is deleted, it will automatically unregister all of its instances. With this policy == true, then all instances will also be disposed
 All Classes Namespaces Functions Variables Enumerations Properties

© 2009-2011 Twin Oaks Computing, Inc
Castle Rock, CO 80108
All rights reserved.