OpenSplice Java 5 DCPS  v6.x
OpenSplice Java 5 OpenSplice Data Distribution Service Data-Centric Publish-Subscribe API
org.omg.dds.topic.PublicationBuiltinTopicData Interface Reference

The DCPSPublication topic communicates the existence of datawriters by means of the PublicationBuiltinTopicData datatype. More...

Inheritance diagram for org.omg.dds.topic.PublicationBuiltinTopicData:
Inheritance graph
Collaboration diagram for org.omg.dds.topic.PublicationBuiltinTopicData:
Collaboration graph

Public Member Functions

PublicationBuiltinTopicData clone ()
 
void copyFrom (PublicationBuiltinTopicData src)
 Overwrite the state of this object with that of the given object. More...
 
List< String > getBaseTypeName ()
 
Deadline getDeadline ()
 
DestinationOrder getDestinationOrder ()
 
Durability getDurability ()
 
DurabilityService getDurabilityService ()
 
ServiceEnvironment getEnvironment ()
 
List< String > getEquivalentTypeName ()
 
GroupData getGroupData ()
 
BuiltinTopicKey getKey ()
 
LatencyBudget getLatencyBudget ()
 
Lifespan getLifespan ()
 
Liveliness getLiveliness ()
 
Ownership getOwnership ()
 
OwnershipStrength getOwnershipStrength ()
 
BuiltinTopicKey getParticipantKey ()
 
Partition getPartition ()
 
Presentation getPresentation ()
 
Reliability getReliability ()
 
DataRepresentation getRepresentation ()
 
TopicData getTopicData ()
 
String getTopicName ()
 
TypeObject getType ()
 
TypeConsistencyEnforcement getTypeConsistency ()
 
String getTypeName ()
 
UserData getUserData ()
 

Detailed Description

The DCPSPublication topic communicates the existence of datawriters by means of the PublicationBuiltinTopicData datatype.

Each PublicationBuiltinTopicData sample in a Domain represents a datawriter in that Domain: a new PublicationBuiltinTopicData instance is created when a newly-added DataWriter is enabled, and it is disposed when that DataWriter is deleted. An updated PublicationBuiltinTopicData sample is written each time the DataWriter (or the Publisher to which it belongs) modifies a QosPolicy that applies to the entities connected to it. Also will it be updated when the writer looses or regains its liveliness.

Definition at line 61 of file PublicationBuiltinTopicData.java.

Member Function Documentation

◆ clone()

PublicationBuiltinTopicData org.omg.dds.topic.PublicationBuiltinTopicData.clone ( )

◆ copyFrom()

void org.omg.dds.topic.PublicationBuiltinTopicData.copyFrom ( PublicationBuiltinTopicData  src)

Overwrite the state of this object with that of the given object.

Implemented in org.opensplice.dds.topic.PublicationBuiltinTopicDataImpl.

◆ getBaseTypeName()

List<String> org.omg.dds.topic.PublicationBuiltinTopicData.getBaseTypeName ( )

◆ getDeadline()

Deadline org.omg.dds.topic.PublicationBuiltinTopicData.getDeadline ( )
Returns
the deadline

Implemented in org.opensplice.dds.topic.PublicationBuiltinTopicDataImpl.

◆ getDestinationOrder()

DestinationOrder org.omg.dds.topic.PublicationBuiltinTopicData.getDestinationOrder ( )
Returns
the destinationOrder

Implemented in org.opensplice.dds.topic.PublicationBuiltinTopicDataImpl.

◆ getDurability()

Durability org.omg.dds.topic.PublicationBuiltinTopicData.getDurability ( )
Returns
the durability

Implemented in org.opensplice.dds.topic.PublicationBuiltinTopicDataImpl.

◆ getDurabilityService()

DurabilityService org.omg.dds.topic.PublicationBuiltinTopicData.getDurabilityService ( )
Returns
the durabilityService

Implemented in org.opensplice.dds.topic.PublicationBuiltinTopicDataImpl.

◆ getEnvironment()

ServiceEnvironment org.omg.dds.core.DDSObject.getEnvironment ( )
inherited
Returns
the org.omg.dds.core.ServiceEnvironment object that directly or indirectly was used to create this object.

Implemented in org.omg.dds.core.ServiceEnvironment, org.opensplice.dds.sub.ReflectionDataReader< TYPE, OUT_TYPE >, org.opensplice.dds.core.ModifiableTimeImpl, org.opensplice.dds.pub.ReflectionDataWriter< TYPE >, org.opensplice.dds.core.DurationImpl, org.opensplice.dds.topic.ContentFilteredTopicImpl< TYPE >, org.opensplice.dds.sub.ReadConditionImpl< TYPE >, org.opensplice.dds.core.EntityQosImpl< T extends QosPolicy >, org.opensplice.dds.type.TypeSupportImpl< TYPE >, org.opensplice.dds.topic.PublicationBuiltinTopicDataImpl, org.opensplice.dds.topic.SubscriptionBuiltinTopicDataImpl, org.opensplice.dds.topic.TopicBuiltinTopicDataImpl, org.opensplice.dds.domain.DomainParticipantFactoryImpl, org.opensplice.dds.core.QosProviderImpl, org.opensplice.dds.core.status.OfferedIncompatibleQosStatusImpl, org.opensplice.dds.core.status.RequestedIncompatibleQosStatusImpl, org.opensplice.dds.core.InstanceHandleImpl, org.opensplice.dds.core.StatusConditionImpl< T extends Entity<?, ?>, org.opensplice.dds.core.status.LivelinessChangedStatusImpl, org.opensplice.dds.core.status.PublicationMatchedStatusImpl, org.opensplice.dds.core.status.SubscriptionMatchedStatusImpl, org.opensplice.dds.sub.SampleImpl< TYPE >, org.opensplice.dds.core.policy.ShareImpl, org.opensplice.dds.core.status.OfferedDeadlineMissedStatusImpl, org.opensplice.dds.core.status.SampleRejectedStatusImpl, org.opensplice.dds.core.WaitSetImpl, org.opensplice.dds.topic.ParticipantBuiltinTopicDataImpl, org.opensplice.dds.core.status.RequestedDeadlineMissedStatusImpl, org.opensplice.dds.topic.BuiltinTopicKeyImpl, org.opensplice.dds.core.GuardConditionImpl, org.opensplice.dds.core.event.AllDataDisposedEventImpl< TYPE >, org.opensplice.dds.core.policy.QosPolicyCountImpl, org.opensplice.dds.core.status.InconsistentTopicStatusImpl, org.opensplice.dds.core.status.LivelinessLostStatusImpl, org.opensplice.dds.core.status.SampleLostStatusImpl, org.opensplice.dds.core.policy.QosPolicyImpl, org.opensplice.dds.core.status.AllDataDisposedStatusImpl, org.opensplice.dds.core.IllegalArgumentExceptionImpl, org.opensplice.dds.core.InconsistentPolicyExceptionImpl, org.opensplice.dds.core.policy.PolicyFactoryImpl, org.opensplice.dds.core.policy.TypeConsistencyEnforcementImpl, org.opensplice.dds.core.PreconditionNotMetExceptionImpl, org.opensplice.dds.core.AlreadyClosedExceptionImpl, org.opensplice.dds.core.IllegalOperationExceptionImpl, org.opensplice.dds.core.ImmutablePolicyExceptionImpl, org.opensplice.dds.core.NotEnabledExceptionImpl, org.opensplice.dds.core.OutOfResourcesExceptionImpl, org.opensplice.dds.core.DDSExceptionImpl, org.opensplice.dds.core.status.DataAvailableStatusImpl, and org.opensplice.dds.core.status.DataOnReadersStatusImpl.

◆ getEquivalentTypeName()

List<String> org.omg.dds.topic.PublicationBuiltinTopicData.getEquivalentTypeName ( )

◆ getGroupData()

GroupData org.omg.dds.topic.PublicationBuiltinTopicData.getGroupData ( )
Returns
the groupData

Implemented in org.opensplice.dds.topic.PublicationBuiltinTopicDataImpl.

◆ getKey()

BuiltinTopicKey org.omg.dds.topic.PublicationBuiltinTopicData.getKey ( )

◆ getLatencyBudget()

LatencyBudget org.omg.dds.topic.PublicationBuiltinTopicData.getLatencyBudget ( )
Returns
the latencyBudget

Implemented in org.opensplice.dds.topic.PublicationBuiltinTopicDataImpl.

◆ getLifespan()

Lifespan org.omg.dds.topic.PublicationBuiltinTopicData.getLifespan ( )
Returns
the lifespan

Implemented in org.opensplice.dds.topic.PublicationBuiltinTopicDataImpl.

◆ getLiveliness()

Liveliness org.omg.dds.topic.PublicationBuiltinTopicData.getLiveliness ( )
Returns
the liveliness

Implemented in org.opensplice.dds.topic.PublicationBuiltinTopicDataImpl.

◆ getOwnership()

Ownership org.omg.dds.topic.PublicationBuiltinTopicData.getOwnership ( )
Returns
the ownership

Implemented in org.opensplice.dds.topic.PublicationBuiltinTopicDataImpl.

◆ getOwnershipStrength()

OwnershipStrength org.omg.dds.topic.PublicationBuiltinTopicData.getOwnershipStrength ( )
Returns
the ownershipStrength

Implemented in org.opensplice.dds.topic.PublicationBuiltinTopicDataImpl.

◆ getParticipantKey()

BuiltinTopicKey org.omg.dds.topic.PublicationBuiltinTopicData.getParticipantKey ( )
Returns
the participantKey

Implemented in org.opensplice.dds.topic.PublicationBuiltinTopicDataImpl.

◆ getPartition()

Partition org.omg.dds.topic.PublicationBuiltinTopicData.getPartition ( )
Returns
the partition

Implemented in org.opensplice.dds.topic.PublicationBuiltinTopicDataImpl.

◆ getPresentation()

Presentation org.omg.dds.topic.PublicationBuiltinTopicData.getPresentation ( )
Returns
the presentation

Implemented in org.opensplice.dds.topic.PublicationBuiltinTopicDataImpl.

◆ getReliability()

Reliability org.omg.dds.topic.PublicationBuiltinTopicData.getReliability ( )
Returns
the reliability

Implemented in org.opensplice.dds.topic.PublicationBuiltinTopicDataImpl.

◆ getRepresentation()

DataRepresentation org.omg.dds.topic.PublicationBuiltinTopicData.getRepresentation ( )

◆ getTopicData()

TopicData org.omg.dds.topic.PublicationBuiltinTopicData.getTopicData ( )
Returns
the topicData

Implemented in org.opensplice.dds.topic.PublicationBuiltinTopicDataImpl.

◆ getTopicName()

String org.omg.dds.topic.PublicationBuiltinTopicData.getTopicName ( )
Returns
the topicName

Implemented in org.opensplice.dds.topic.PublicationBuiltinTopicDataImpl.

◆ getType()

TypeObject org.omg.dds.topic.PublicationBuiltinTopicData.getType ( )

◆ getTypeConsistency()

TypeConsistencyEnforcement org.omg.dds.topic.PublicationBuiltinTopicData.getTypeConsistency ( )

◆ getTypeName()

String org.omg.dds.topic.PublicationBuiltinTopicData.getTypeName ( )
Returns
the typeName

Implemented in org.opensplice.dds.topic.PublicationBuiltinTopicDataImpl.

◆ getUserData()

UserData org.omg.dds.topic.PublicationBuiltinTopicData.getUserData ( )
Returns
the userData

Implemented in org.opensplice.dds.topic.PublicationBuiltinTopicDataImpl.


The documentation for this interface was generated from the following file: