OpenDDSharp.DDS Namespace |
Class | Description | |
---|---|---|
Condition |
A Condition is a root class for all the conditions that may be attached to a WaitSet. This basic class is specialized in three
classes that are known by the middleware: GuardCondition, StatusCondition, and ReadCondition | |
ContentFilteredTopic |
ContentFilteredTopic is an implementation of ITopicDescription that allows for content-based subscriptions.
ContentFilteredTopic describes a more sophisticated subscription that indicates the subscriber does not want to necessarily see
all values of each instance published under the Topic. Rather, it wants to see only the values whose contents satisfy certain
criteria. This class therefore can be used to request content-based subscriptions.
| |
DataReader |
A DataReader allows the application to declare the data it wishes to receive (i.e., make a subscription) and to access the
data received by the attached Subscriber.
| |
DataReaderQos |
Holds the DataReader Quality of Service policies.
| |
DataWriter |
DataWriter allows the application to set the value of the data to be published under a given Topic.
| |
DataWriterQos |
Holds the DataWriter Quality of Service policies.
| |
DeadlineQosPolicy |
This policy is useful for cases where a Topic is expected to have each instance updated periodically. On the publishing side this
setting establishes a contract that the application must meet. On the subscribing side the setting establishes a minimum
requirement for the remote publishers that are expected to supply the data values.
| |
DestinationOrderQosPolicy |
This policy controls how each Subscriber resolves the final value of a data instance that is written by multiple DataWriter
objects (which may be associated with different Publisher objects) running on different nodes.
| |
DomainParticipant | The DomainParticipant represents the participation of the application on a communication plane that isolates applications running on the same set of physical computers from each other. A domain establishes a virtual network linking all applications that share the same DomainId and isolating them from applications running on different domains. In this way, several independent distributed applications can coexist in the same physical network without interfering, or even being aware of each other. | |
DomainParticipantFactory |
Allows the creation and destruction of DomainParticipant objects.
| |
DomainParticipantFactoryQos |
Holds the DomainParticipantFactory Quality of Service policies.
| |
DomainParticipantQos |
Holds the DomainParticipant Quality of Service policies.
| |
DurabilityQosPolicy |
The durability policy controls whether data writers should maintain samples after they
have been sent to known subscribers. This policy applies to the Topic, DataReader, and
DataWriter entities via the durability member of their respective QoS structures.
| |
DurabilityServiceQosPolicy |
This policy is used to configure the history QoS and the resource limits QoS used by the fictitious DataReader and
DataWriter used by the "persistence service".
| |
Entity |
This class is the abstract base class for all the DCPS objects that support QoS policies, a listener and a status condition. That is,
DomainParticipant, Topic, Publisher, Subscriber, DataWriter and DataReader.
| |
EntityFactoryQosPolicy |
This policy controls the behavior of the Entity as a factory for other entities.
| |
GroupDataQosPolicy |
The purpose of this QoS is to allow the application to attach additional information to the created Publisher or Subscriber.
The value of the GroupData is available to the application on the DataReader and DataWriter entities and is propagated by
means of the built-in topics.
| |
GuardCondition |
A GuardCondition object is a specific Condition whose TriggerValue is completely under the control of the application.
| |
HistoryQosPolicy |
This policy controls the behavior of DDS when the value of an instance changes before it is finally communicated to some of its existing DataReader entities.
| |
LatencyBudgetQosPolicy |
This policy provides a means for the application to indicate to the middleware the “urgency” of the data-communication. By
having a non-zero duration DDS can optimize its internal operation. This policy is considered a hint. There is no specified mechanism as
to how the service should take advantage of this hint.
| |
LifespanQosPolicy | The purpose of this QoS is to avoid delivering "stale" data to the application. Each data sample written by the DataWriter has an associated 'expiration time' beyond which the data should not be delivered to any application. Once the sample expires, the data will be removed from the DataReader caches as well as from the transient and persistent information caches. | |
LivelinessQosPolicy |
This policy controls the mechanism and parameters used by DDS to ensure that particular entities on the network are still "alive".
| |
MultiTopic |
MultiTopic is an implementation of ITopicDescription that allows subscriptions to combine/filter/rearrange data coming from
several topics. MultiTopic allows a more sophisticated subscription that can select and combine data received from multiple topics into a
single resulting type(specified by the inherited type name). The data will then be filtered(selection) and possibly re-arranged
(aggregation/projection) according to a subscription expression with the expression parameters.
| |
OwnershipQosPolicy |
This policy controls whether DDS allows multiple DataWriter objects to update the same instance (identified by Topic + key) of a data-object.
| |
OwnershipStrengthQosPolicy |
This QoS policy should be used in combination with the Ownership policy. It only applies to the situation case where
ownership kind is set to Exclusive.
| |
ParticipantBuiltinTopicDataDataReader | ||
PartitionQosPolicy |
This policy allows the introduction of a logical partition concept inside the 'physical' partition induced by a domain.
| |
PresentationQosPolicy |
The Presentation QoS policy controls how changes to instances by publishers are presented to data readers. It affects the relative ordering of these changes and
the scope of this ordering. Additionally, this policy introduces the concept of coherent change sets.
| |
PublicationBuiltinTopicDataDataReader | ||
Publisher |
A Publisher is the object responsible for the actual dissemination of publications.
| |
PublisherListener |
Abstract class that can be implemented by an application-provided class and then registered with the Publisher
such that the application can be notified of relevant status changes.
| |
PublisherQos |
Holds the Publisher Quality of Service policies.
| |
QosPolicyCount |
Hold a counter for the QoS policies
| |
QueryCondition |
QueryCondition objects are specialized ReadCondition objects that allow the application to also specify a filter on the locally available data.
| |
ReadCondition |
ReadCondition objects are conditions specifically dedicated to read operations and attached to one DataReader | |
ReaderDataLifecycleQosPolicy |
This policy controls the behavior of the DataReader with regards to the lifecycle of the data-instances it manages, that is, the
data-instances that have been received and for which the DataReader maintains some internal resources.
| |
ReliabilityQosPolicy |
This policy indicates the level of reliability requested by a DataReader or offered by a DataWriter.
| |
ResourceLimitsQosPolicy |
This policy controls the resources that DDS can use in order to meet the requirements imposed by the application and other QoS settings.
| |
SampleInfo |
Information that accompanies each sample that is read or taken.
| |
StatusCondition |
A StatusCondition object is a specific Condition that is associated with each Entity.
The TriggerValue of the StatusCondition depends on the communication status of that entity (e.g., arrival of data, loss of
information, etc.), 'filtered' by the set of EnabledStatuses on the StatusCondition.
| |
Subscriber |
A Subscriber is the object responsible for the actual reception of the data resulting from its subscriptions.
| |
SubscriberListener |
Abstract class that can be implemented by an application-provided class and then registered with the Subscriber
such that the application can be notified of relevant status changes.
| |
SubscriberQos |
Holds the Subscriber Quality of Service policies.
| |
SubscriptionBuiltinTopicDataDataReader | ||
TimeBasedFilterQosPolicy |
This policy allows a DataReader to indicate that it does not necessarily want to see all values of each instance published under
the Topic. Rather, it wants to see at most one change every MinimumSeparation period.
| |
Topic |
Topic is the most basic description of the data to be published and subscribed.
A Topic is identified by its name, which must be unique in the whole Domain. In addition (by virtue of implemeting
ITopicDescription) it fully specifies the type of the data that can be communicated when publishing or subscribing to the Topic.
Topic is the only ITopicDescription that can be used for publications and therefore associated to a DataWriter.
| |
TopicBuiltinTopicDataDataReader | ||
TopicDataQosPolicy |
The purpose of this QoS is to allow the application to attach additional information to the created Topic such that when a
remote application discovers their existence it can examine the information and use it in an application-defined way.
| |
TopicDescription |
Default implementation of the ITopicDescription interface.
It is the base class for ContentFilteredTopic, and MultiTopic.
| |
TopicListener |
Abstract class that can be implemented by an application-provided class and then registered with the Topic
such that the application can be notified of relevant status changes.
| |
TopicQos |
Holds the Topic Quality of Service policies.
| |
TransportPriorityQosPolicy |
The purpose of this QoS is to allow the application to take advantage of transports capable of sending messages with different priorities.
| |
UserDataQosPolicy |
The purpose of this QoS is to allow the application to attach additional information to the created Entity objects such that when
a remote application discovers their existence it can access that information and use it for its own purposes.
| |
WaitSet |
A WaitSet object allows an application to wait until one or more of the attached Condition objects has a TriggerValue of
or else until the timeout expires.
| |
WriterDataLifecycleQosPolicy |
This policy controls the behavior of the DataWriter with regards to the lifecycle of the data-instances it manages, that is, the
data-instances that have been either explicitly registered with the DataWriter using the register operations or implicitly by directly writing the data.
|
Structure | Description | |
---|---|---|
BuiltinTopicKey |
Global unique identifier of the built-in topics.
| |
Duration |
Structure for duration representation
| |
InconsistentTopicStatus |
The InconsistentTopic status indicates that a topic was attempted to be registered that already exists with different characteristics.
Typically, the existing topic may have a different type associated with it.
| |
InstanceHandle |
Type definition for an instance handle.
| |
InstanceStateKind |
Indicates if the samples are from a live DataWriter or not.
| |
InstanceStateMask |
Represent a bit-mask of InstanceStateKind | |
LivelinessChangedStatus |
The LivelinessChanged status indicates that there have been liveliness changes for one or more data writers that are publishing instances for this data reader.
| |
LivelinessLostStatus |
The LivelinessLost status indicates that the liveliness that the data writer committed through its Liveliness QoS has not been respected.
This means that any connected data readers will consider this DataWriter no longer active.
| |
OfferedDeadlineMissedStatus |
The OfferedDeadlineMissed status indicates that the deadline offered by the DataWriter has been missed for one or more instances.
| |
OfferedIncompatibleQosStatus |
The OfferedIncompatibleQos status indicates that an offered QoS was incompatible with the requested QoS of a DataReader.
| |
ParticipantBuiltinTopicData |
Class that contains information about available DomainParticipants within the system.
| |
PublicationBuiltinTopicData |
Class that contains information about available DataWriters within the system.
| |
PublicationMatchedStatus |
The PublicationMatched status indicates that either a compatible DataReader has been matched or a previously matched DataReader has ceased to be matched.
| |
RequestedDeadlineMissedStatus |
The RequestedDeadlineMissed status indicates that the deadline requested via the DeadlineQosPolicy was not respected for a specific instance.
| |
RequestedIncompatibleQosStatus |
The RequestedIncompatibleQos status indicates that one or more QoS policy values that were requested were incompatible with what was offered.
| |
SampleLostStatus |
The SampleLost status indicates that a sample has been lost and never received by the DataReader.
| |
SampleRejectedStatus |
The SampleRejected status indicates that a sample received by the data reader has been rejected.
| |
SampleStateKind |
Indicates whether or not a sample has ever been read.
| |
SampleStateMask |
Represent a bit-mask of SampleStateKind | |
StatusKind |
Kinds of communication status.
| |
StatusMask |
Represent a bit-mask of StatusKind | |
SubscriptionBuiltinTopicData |
Class that contains information about available DataReaders within the system.
| |
SubscriptionMatchedStatus |
The SubscriptionMatched status indicates that either a compatible DataWriter has been matched or a previously matched data writer has ceased to be matched.
| |
Timestamp |
Structure for timestamp representation
| |
TopicBuiltinTopicData |
Class that contains information about available Topics within the system.
| |
ViewStateKind |
Indicates whether or not an instance is new.
| |
ViewStateMask |
Represent a bit-mask of ViewStateKind |
Interface | Description | |
---|---|---|
ITopicDescription |
ITopicDescription represents the fact that both publications and subscriptions are tied to a single data-type.
The interface is implemented on Topic, ContentFilteredTopic, and MultiTopic.
|
Enumeration | Description | |
---|---|---|
DestinationOrderQosPolicyKind |
This enumeration defines the valid kinds of the DestinationOrderQosPolicy Kind.
| |
DurabilityQosPolicyKind |
This enumeration defines the valid kinds of the DurabilityQosPolicy Kind.
| |
HistoryQosPolicyKind |
This enumeration defines the valid kinds of the HistoryQosPolicy Kind.
| |
LivelinessQosPolicyKind |
This enumeration defines the valid kinds of the LivelinessQosPolicy Kind.
| |
OwnershipQosPolicyKind |
This enumeration defines the valid kinds of the OwnershipQosPolicy Kind.
| |
PresentationQosPolicyAccessScopeKind |
This enumeration defines the valid kinds of the PresentationQosPolicy AccessScope.
| |
ReliabilityQosPolicyKind |
This enumeration defines the valid kinds of the ReliabilityQosPolicy Kind.
| |
ReturnCode |
Represents the various return code values that DDS operations return.
| |
SampleRejectedStatusKind |
This enumeration defines the valid values of the SampleRejectedStatus LastReason.
|