Click or drag to resize

DataWriter Class

DataWriter allows the application to set the value of the data to be published under a given Topic.
Inheritance Hierarchy

Namespace:  OpenDDSharp.DDS
Assembly:  OpenDDSharp (in OpenDDSharp.dll) Version: 0.4.1.0
Syntax
public class DataWriter : Entity

The DataWriter type exposes the following members.

Properties
  NameDescription
Public propertyInstanceHandle
Gets the InstanceHandle that represents the Entity.
(Inherited from Entity.)
Public propertyPublisher
Gets the Publisher to which the DataWriter belongs.
Public propertyStatusChanges
Gets the list of communication statuses in the Entity that are 'triggered'. That is, the list of statuses whose value has changed since the last time the application read the status.
(Inherited from Entity.)
Public propertyStatusCondition
Allows access to the StatusCondition associated with the Entity. The returned condition can then be added to a WaitSet so that the application can wait for specific status changes that affect the Entity.
(Inherited from Entity.)
Public propertyTopic
Gets the Topic associated with the DataWriter. This is the same Topic that was used to create the DataWriter.
Top
Methods
  NameDescription
Public methodAssertLiveliness
Manually asserts the liveliness of the DataWriter. This is used in combination with the liveliness QoS policy to indicate to DDS that the entity remains active.
Public methodEnable
Enables the Entity. The enable operation is idempotent. Calling enable on an already enabled Entity returns Ok and has no effect.
(Inherited from Entity.)
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetListener
Allows access to the attached DataWriterListener.
Public methodGetLivelinessLostStatus
Allows access to the LivelinessLostStatus communication status.
Public methodGetMatchedSubscriptionData
Retrieves information on a subscription that is currently "associated" with the DataWriter; that is, a subscription with a matching Topic and compatible QoS that the application has not indicated should be "ignored" by means of the DomainParticipant IgnoreSubscription operation.
Public methodGetMatchedSubscriptions
Gets the collection of subscriptions currently "associated" with the DataWriter; that is, subscriptions that have a matching Topic and compatible QoS that the application has not indicated should be "ignored" by means of the DomainParticipant IgnoreSubscription operation.
Public methodGetOfferedDeadlineMissedStatus
Allows access to the OfferedDeadlineMissedStatus communication status.
Public methodGetOfferedIncompatibleQosStatus
Allows access to the OfferedIncompatibleQosStatus communication status.
Public methodGetPublicationMatchedStatus
Allows access to the PublicationMatchedStatus communication status.
Public methodGetQos
Gets the DataWriter QoS policies.
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodSetListener(DataWriterListener)
Public methodSetListener(DataWriterListener, StatusMask)
Sets the DataWriterListener.
Public methodSetQos
Sets the DataWriter QoS policies.
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Public methodWaitForAcknowledgments
Blocks the calling thread until either all data written by the DataWriter is acknowledged by all matched DataReader entities that have ReliableReliabilityQos, or else the duration specified by the maxWait parameter elapses, whichever happens first.
Top
Remarks

A DataWriter is attached to exactly one Publisher that acts as a factory for it.

A DataWriter is bound to exactly one Topic and therefore to exactly one data type. The Topic must exist prior to the DataWriter’s creation.

The DataWriter must be specialized for each particular application data-type.

All operations except for the operations SetQos(DataWriterQos), GetQos(DataWriterQos), SetListener, GetListener, Enable, and StatusCondition return the value NotEnabled if the DataWriter has not been enabled yet.

See Also