CoreDX DDS
C# Reference Manual

com::toc::coredx::DDS Namespace Reference

Namespaces

namespace  Extensions

Classes

struct  Duration_t
 Duration_t is used to indicate a duration of time. More...
struct  Time_t
 Time_t is used to specify an point in time. More...
class  DDS
 The 'DDS' class includes several convient constants. More...
class  InconsistentTopicStatus
 Status related to the on_inconsistent_topic listener methods of the TopicListener structure. More...
class  OfferedDeadlineMissedStatus
 Status related to the on_offered_deadline_missed listener methods of the DataWriter, Publisher, and DomainParticipant structures. More...
class  OfferedIncompatibleQosStatus
 Status related to the on_offered_incompatible_qos listener methods of the DataWriter, Publisher, and DomainParticipant structures. More...
class  LivelinessLostStatus
 Status related to the on_liveliness_lost listener methods of the DataWriter, Publisher, and DomainParticipant structures. More...
class  PublicationMatchedStatus
 Status related to the on_publication_matched listener methods of the DataWriter, Publisher, and DomainParticipant structures. More...
class  RequestedDeadlineMissedStatus
 Status related to the on_requested_deadline_missed listener methods of the DataReader, Subscriber, and DomainParticipant structures. More...
class  RequestedIncompatibleQosStatus
 Status related to the on_requested_incompatible_qos listener methods of the DataReader, Subscriber, and DomainParticipant structures. More...
class  SampleRejectedStatus
 Status related to the on_sample_rejected listener methods of the DataReader, Subscriber, and DomainParticipant structures. More...
class  LivelinessChangedStatus
 Status related to the on_liveliness_changed listener methods of the DataReader, Subscriber, and DomainParticipant structures. More...
class  SubscriptionMatchedStatus
 Status related to the on_subscription_matched listener methods of the DataReader, Subscriber, and DomainParticipant structures. More...
class  SampleLostStatus
 Status related to the on_sample_lost listener methods of the DataReader, Subscriber, and DomainParticipant structures. More...
class  DomainParticipantListener
 The DomainParticipantListener provides asynchronous notification of DomainParticipant events. More...
class  TopicListener
 The TopicListener provides asynchronous notification of Topic events. More...
class  PublisherListener
 The PublisherListener provides asynchronous notification of Publisher events. More...
class  DataWriterListener
 The DataWriterListener provides asynchronous notification of DataWriter events. More...
class  SubscriberListener
 The SubscriberListener provides asynchronous notification of Subscriber events. More...
class  DataReaderListener
 The DataReaderListener provides asynchronous notification of DataReader events. More...
struct  UserDataQosPolicy
 Allows the application to attach arbitrary information to a DomainParticipant, DataWriter or DataReader. More...
struct  TopicDataQosPolicy
 Allows the application to attach arbitrary information to a Topic QoS. More...
struct  GroupDataQosPolicy
 Allows the application to attach arbitrary information to a Publisher or Subscriber. More...
struct  TransportPriorityQosPolicy
 A hint to the middleware to help configure the transport priority mechanism. More...
struct  LifespanQosPolicy
 Specifies the maximum duration of validity of the data written by the DataWriter. More...
struct  DurabilityQosPolicy
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  DeadlineQosPolicy
 This QoS policy establishes a minimum update period for data instances. More...
struct  LatencyBudgetQosPolicy
 Specifies allowable latency. 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  LivelinessQosPolicy
 Determines the mechanism and parameters used by the application to determine whether an Entity is alive. 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...
struct  PartitionQosPolicy
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  DestinationOrderQosPolicy
 This QoS policy controls how each Subscriber orders received data samples. More...
struct  HistoryQosPolicy
 Controls the ammount of historical data maintained by a DataReader or DataWriter. More...
struct  ResourceLimitsQosPolicy
 Specifies the resources that the Service can use to maintain data samples and instances. More...
struct  EntityFactoryQosPolicy
struct  WriterDataLifecycleQosPolicy
 Specifies 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. More...
struct  ReaderDataLifecycleQosPolicy
 Specifies the lifecycle behavior of data instances managed by the DataReader. More...
struct  DurabilityServiceQosPolicy
struct  RTPSWriterQosPolicy
struct  RTPSReaderQosPolicy
class  DomainParticipantFactoryQos
 Structure that holds DomainParticipantFactory Quality of Service policies. More...
class  DomainParticipantQos
 Structure that holds DomainParticipant Quality of Service policies. More...
class  TopicQos
 Structure that holds DDS_Topic Quality of Service policies. More...
class  PublisherQos
 Structure that holds Publisher Quality of Service policies. More...
class  SubscriberQos
 Structure that holds DDS_Subscriber Quality of Service policies. More...
class  DataWriterQos
 Structure that holds DataWriter Quality of Service policies. More...
class  DataReaderQos
 Structure that holds DataReader Quality of Service policies. More...
class  Condition
 A Condition can be added to a WaitSet to provide synchronous event notification. More...
class  GuardCondition
 A GuardCondition is a Condition where the trigger_value is under application control. More...
class  StatusCondition
 A StatusCondition is a condition associated with an Entity. The trigger_value is driven by the communication status of the associated Entity. More...
class  ReadCondition
 A ReadCondition is a specialized Condition associated with a DataReader. More...
class  QueryCondition
 The trigger_value is driven by the data available, after applying the filter, in the associated DataReader. 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  DataReader
 The DataReader entity allows the application to subscribe to and read data. More...
class  DataWriter
 The 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. More...
class  Entity
 Base class for all DDS Entities. More...
class  DomainEntity
 Base class for all DDS Domain Entities. More...
class  Publisher
 The Publisher configures, creates, manages and destroys DataWriters. More...
class  SampleInfo
 The 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. More...
class  Subscriber
 The Subscriber configures, creates, manages and destroys DataReaders. More...
interface  TopicDescription
 TopicDescription is an interface that provides the foundation for Topic, ContentFilteredTopic, and MultiTopic. More...
class  Topic
 Topic 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.]. More...
class  ContentFilteredTopic
 ContentFilteredTopic 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. More...
class  WaitSet
 A 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. More...

Enumerations

enum  ReturnCode_t {
  RETCODE_OK, RETCODE_ERROR, RETCODE_UNSUPPORTED, RETCODE_BAD_PARAMETER,
  RETCODE_PRECONDITION_NOT_MET, RETCODE_OUT_OF_RESOURCES, RETCODE_NOT_ENABLED, RETCODE_IMMUTABLE_POLICY,
  RETCODE_INCONSISTENT_POLICY, RETCODE_ALREADY_DELETED, RETCODE_TIMEOUT, RETCODE_NO_DATA
}
 

ReturnCode_t is used to indicate success or failure of an API method.

More...
enum  QosPolicyId_t {
  USERDATA_QOS_POLICY_ID = 1, DURABILITY_QOS_POLICY_ID, PRESENTATION_QOS_POLICY_ID, DEADLINE_QOS_POLICY_ID,
  LATENCYBUDGET_QOS_POLICY_ID, OWNERSHIP_QOS_POLICY_ID, OWNERSHIPSTRENGTH_QOS_POLICY_ID, LIVELINESS_QOS_POLICY_ID,
  TIMEBASEDFILTER_QOS_POLICY_ID, PARTITION_QOS_POLICY_ID, RELIABILITY_QOS_POLICY_ID, DESTINATIONORDER_QOS_POLICY_ID,
  HISTORY_QOS_POLICY_ID, RESOURCELIMITS_QOS_POLICY_ID, ENTITYFACTORY_QOS_POLICY_ID, WRITERDATALIFECYCLE_QOS_POLICY_ID,
  READERDATALIFECYCLE_QOS_POLICY_ID, TOPICDATA_QOS_POLICY_ID, GROUPDATA_QOS_POLICY_ID, TRANSPORTPRIORITY_QOS_POLICY_ID,
  LIFESPAN_QOS_POLICY_ID, DURABILITYSERVICE_QOS_POLICY_ID
}
 

QosPolicyId_t is used to uniquely indicate a QoS Policy.

More...
enum  SampleRejectedStatusKind { NOT_REJECTED, REJECTED_BY_INSTANCE_LIMIT, REJECTED_BY_SAMPLES_LIMIT, REJECTED_BY_SAMPLES_PER_INSTANCE_LIMIT }
enum  DurabilityQosPolicyKind { VOLATILE_DURABILITY_QOS, TRANSIENT_LOCAL_DURABILITY_QOS, TRANSIENT_DURABILITY_QOS, PERSISTENT_DURABILITY_QOS }
enum  PresentationQosPolicyAccessScopeKind { INSTANCE_PRESENTATION_QOS, TOPIC_PRESENTATION_QOS, GROUP_PRESENTATION_QOS }
enum  OwnershipQosPolicyKind { SHARED_OWNERSHIP_QOS, EXCLUSIVE_OWNERSHIP_QOS }
enum  LivelinessQosPolicyKind { AUTOMATIC_LIVELINESS_QOS, MANUAL_BY_PARTICIPANT_LIVELINESS_QOS, MANUAL_BY_TOPIC_LIVELINESS_QOS }
enum  ReliabilityQosPolicyKind { RELIABILITY_PLACEHOLDER_QOS, BEST_EFFORT_RELIABILITY_QOS, RELIABLE_RELIABILITY_QOS }
enum  DestinationOrderQosPolicyKind { BY_RECEPTION_TIMESTAMP_DESTINATIONORDER_QOS, BY_SOURCE_TIMESTAMP_DESTINATIONORDER_QOS }
enum  HistoryQosPolicyKind { KEEP_LAST_HISTORY_QOS, KEEP_ALL_HISTORY_QOS }
enum  DiscoveryQosPolicyDiscoveryKind { PEER_DISCOVERY_QOS, CENTRAL_DISCOVERY_QOS }

Functions

delegate void inconsistent_topic_delegate (Topic topic, InconsistentTopicStatus status)
delegate void offered_deadline_missed_delegate (DataWriter writer, OfferedDeadlineMissedStatus status)
delegate void offered_incompatible_qos_delegate (DataWriter writer, OfferedIncompatibleQosStatus status)
delegate void liveliness_lost_delegate (DataWriter writer, LivelinessLostStatus status)
delegate void publication_matched_delegate (DataWriter writer, PublicationMatchedStatus status)
delegate void requested_deadline_missed_delegate (DataReader reader, RequestedDeadlineMissedStatus status)
delegate void requested_incompatible_qos_delegate (DataReader reader, RequestedIncompatibleQosStatus status)
delegate void sample_rejected_delegate (DataReader reader, SampleRejectedStatus status)
delegate void liveliness_changed_delegate (DataReader reader, LivelinessChangedStatus status)
delegate void data_available_delegate (DataReader reader)
delegate void subscription_matched_delegate (DataReader reader, SubscriptionMatchedStatus status)
delegate void sample_lost_delegate (DataReader reader, SampleLostStatus status)
delegate void data_on_readers_delegate (Subscriber subscriber)

Enumeration Type Documentation

Enumerator:
BY_RECEPTION_TIMESTAMP_DESTINATIONORDER_QOS 
BY_SOURCE_TIMESTAMP_DESTINATIONORDER_QOS 
Enumerator:
PEER_DISCOVERY_QOS 
CENTRAL_DISCOVERY_QOS 
Enumerator:
VOLATILE_DURABILITY_QOS 
TRANSIENT_LOCAL_DURABILITY_QOS 
TRANSIENT_DURABILITY_QOS 
PERSISTENT_DURABILITY_QOS 
Enumerator:
KEEP_LAST_HISTORY_QOS 
KEEP_ALL_HISTORY_QOS 
Enumerator:
AUTOMATIC_LIVELINESS_QOS 
MANUAL_BY_PARTICIPANT_LIVELINESS_QOS 
MANUAL_BY_TOPIC_LIVELINESS_QOS 
Enumerator:
SHARED_OWNERSHIP_QOS 
EXCLUSIVE_OWNERSHIP_QOS 
Enumerator:
INSTANCE_PRESENTATION_QOS 
TOPIC_PRESENTATION_QOS 
GROUP_PRESENTATION_QOS 

QosPolicyId_t is used to uniquely indicate a QoS Policy.

Enumerator:
USERDATA_QOS_POLICY_ID 
DURABILITY_QOS_POLICY_ID 
PRESENTATION_QOS_POLICY_ID 
DEADLINE_QOS_POLICY_ID 
LATENCYBUDGET_QOS_POLICY_ID 
OWNERSHIP_QOS_POLICY_ID 
OWNERSHIPSTRENGTH_QOS_POLICY_ID 
LIVELINESS_QOS_POLICY_ID 
TIMEBASEDFILTER_QOS_POLICY_ID 
PARTITION_QOS_POLICY_ID 
RELIABILITY_QOS_POLICY_ID 
DESTINATIONORDER_QOS_POLICY_ID 
HISTORY_QOS_POLICY_ID 
RESOURCELIMITS_QOS_POLICY_ID 
ENTITYFACTORY_QOS_POLICY_ID 
WRITERDATALIFECYCLE_QOS_POLICY_ID 
READERDATALIFECYCLE_QOS_POLICY_ID 
TOPICDATA_QOS_POLICY_ID 
GROUPDATA_QOS_POLICY_ID 
TRANSPORTPRIORITY_QOS_POLICY_ID 
LIFESPAN_QOS_POLICY_ID 
DURABILITYSERVICE_QOS_POLICY_ID 
Enumerator:
RELIABILITY_PLACEHOLDER_QOS 
BEST_EFFORT_RELIABILITY_QOS 
RELIABLE_RELIABILITY_QOS 

ReturnCode_t is used to indicate success or failure of an API method.

Enumerator:
RETCODE_OK 
RETCODE_ERROR 
RETCODE_UNSUPPORTED 
RETCODE_BAD_PARAMETER 
RETCODE_PRECONDITION_NOT_MET 
RETCODE_OUT_OF_RESOURCES 
RETCODE_NOT_ENABLED 
RETCODE_IMMUTABLE_POLICY 
RETCODE_INCONSISTENT_POLICY 
RETCODE_ALREADY_DELETED 
RETCODE_TIMEOUT 
RETCODE_NO_DATA 

Function Documentation

delegate void com::toc::coredx::DDS::data_available_delegate ( DataReader  reader  ) 

invoked as listener in response to data_available condition

delegate void com::toc::coredx::DDS::data_on_readers_delegate ( Subscriber  subscriber  ) 

invoked as listener in response to data_on_readers condition

delegate void com::toc::coredx::DDS::inconsistent_topic_delegate ( Topic  topic,
InconsistentTopicStatus  status 
)

invoked as listener in response to inconsistent topic condition

delegate void com::toc::coredx::DDS::liveliness_changed_delegate ( DataReader  reader,
LivelinessChangedStatus  status 
)

invoked as listener in response to liveliness_changed condition

delegate void com::toc::coredx::DDS::liveliness_lost_delegate ( DataWriter  writer,
LivelinessLostStatus  status 
)

invoked as listener in response to liveliness_lost condition

delegate void com::toc::coredx::DDS::offered_deadline_missed_delegate ( DataWriter  writer,
OfferedDeadlineMissedStatus  status 
)

invoked as listener in response to offered deadline missed condition

delegate void com::toc::coredx::DDS::offered_incompatible_qos_delegate ( DataWriter  writer,
OfferedIncompatibleQosStatus  status 
)

invoked as listener in response to offered_incompatible_qos condition

delegate void com::toc::coredx::DDS::publication_matched_delegate ( DataWriter  writer,
PublicationMatchedStatus  status 
)

invoked as listener in response to publication_matched condition

delegate void com::toc::coredx::DDS::requested_deadline_missed_delegate ( DataReader  reader,
RequestedDeadlineMissedStatus  status 
)

invoked as listener in response to requested_deadline_missed condition

delegate void com::toc::coredx::DDS::requested_incompatible_qos_delegate ( DataReader  reader,
RequestedIncompatibleQosStatus  status 
)

invoked as listener in response to requested_incompatible_qos condition

delegate void com::toc::coredx::DDS::sample_lost_delegate ( DataReader  reader,
SampleLostStatus  status 
)

invoked as listener in response to sample_lost condition

delegate void com::toc::coredx::DDS::sample_rejected_delegate ( DataReader  reader,
SampleRejectedStatus  status 
)

invoked as listener in response to sample_rejected condition

delegate void com::toc::coredx::DDS::subscription_matched_delegate ( DataReader  reader,
SubscriptionMatchedStatus  status 
)

invoked as listener in response to subscription_matched condition

 All Classes Namespaces Functions Variables Enumerations Properties

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