Inheritance diagram for org.opensplice.dds.core.policy.PresentationImpl:

Collaboration diagram for org.opensplice.dds.core.policy.PresentationImpl:

Public Member Functions
	PresentationImpl (OsplServiceEnvironment environment)

	PresentationImpl (OsplServiceEnvironment environment, AccessScopeKind accessScope, boolean coherentAccess, boolean orderedAccess)

int	compareTo (Presentation o)

boolean	equals (Object other)

AccessScopeKind	getAccessScope ()

ServiceEnvironment	getEnvironment ()

Class<? extends QosPolicy >	getPolicyClass ()

int	hashCode ()

boolean	isCoherentAccess ()
	If coherentAccess is set, then the accessScope controls the maximum extent of coherent changes. More...

boolean	isOrderedAccess ()
	If orderedAccess is set, then the accessScope controls the maximum extent for which order will be preserved by the Service. More...

Comparable< Presentation >	requestedOfferedContract ()

Presentation	withAccessScope (AccessScopeKind accessScope)
	Copy this policy and override the value of the property. More...

Presentation	withCoherentAccess (boolean coherentAccess)
	Copy this policy and override the value of the property. More...

Presentation	withGroup ()

Presentation	withInstance ()

Presentation	withOrderedAccess (boolean orderedAccess)
	Copy this policy and override the value of the property. More...

Presentation	withTopic ()

Protected Attributes
OsplServiceEnvironment	environment

Detailed Description

Definition at line 28 of file PresentationImpl.java.

Constructor & Destructor Documentation

◆ PresentationImpl() [1/2]

org.opensplice.dds.core.policy.PresentationImpl.PresentationImpl ( OsplServiceEnvironment environment )

Definition at line 34 of file PresentationImpl.java.

◆ PresentationImpl() [2/2]

org.opensplice.dds.core.policy.PresentationImpl.PresentationImpl	(	OsplServiceEnvironment	environment,
		AccessScopeKind	accessScope,
		boolean	coherentAccess,
		boolean	orderedAccess
	)

Definition at line 41 of file PresentationImpl.java.

Member Function Documentation

◆ compareTo()

int org.opensplice.dds.core.policy.PresentationImpl.compareTo ( Presentation o )

Definition at line 61 of file PresentationImpl.java.

◆ equals()

boolean org.opensplice.dds.core.policy.PresentationImpl.equals ( Object other )

Definition at line 95 of file PresentationImpl.java.

◆ getAccessScope()

AccessScopeKind org.opensplice.dds.core.policy.PresentationImpl.getAccessScope ( )

Returns: the accessScope

Implements org.omg.dds.core.policy.Presentation.

Definition at line 114 of file PresentationImpl.java.

◆ getEnvironment()

ServiceEnvironment org.opensplice.dds.core.policy.QosPolicyImpl.getEnvironment ( )

inherited

Returns: the org.omg.dds.core.ServiceEnvironment object that directly or indirectly was used to create this object.

Implements org.omg.dds.core.DDSObject.

Definition at line 40 of file QosPolicyImpl.java.

◆ getPolicyClass()

Class<? extends QosPolicy> org.opensplice.dds.core.policy.PresentationImpl.getPolicyClass ( )

Definition at line 165 of file PresentationImpl.java.

◆ hashCode()

int org.opensplice.dds.core.policy.PresentationImpl.hashCode ( )

Definition at line 170 of file PresentationImpl.java.

◆ isCoherentAccess()

boolean org.opensplice.dds.core.policy.PresentationImpl.isCoherentAccess ( )

If coherentAccess is set, then the accessScope controls the maximum extent of coherent changes.

The behavior is as follows:

If accessAcope is set to Presentation.AccessScopeKind#INSTANCE, the use of org.omg.dds.pub.Publisher#beginCoherentChanges() and org.omg.dds.pub.Publisher#endCoherentChanges() has no effect on how the subscriber can access the data because with the scope limited to each instance, changes to separate instances are considered independent and thus cannot be grouped by a coherent change.
If accessScope is set to Presentation.AccessScopeKind#TOPIC, then coherent changes (indicated by their enclosure within calls to org.omg.dds.pub.Publisher#beginCoherentChanges() and org.omg.dds.pub.Publisher#endCoherentChanges()) will be made available as such to each remote org.omg.dds.sub.DataReader independently. That is, changes made to instances within each individual org.omg.dds.pub.DataWriter will be available as coherent with respect to other changes to instances in that same DataWriter, but will not be grouped with changes made to instances belonging to a different DataWriter.
If accessScope is set to Presentation.AccessScopeKind#GROUP, then coherent changes made to instances through a DataWriter attached to a common org.omg.dds.pub.Publisher are made available as a unit to remote subscribers.

See also: getAccessScope()

Implements org.omg.dds.core.policy.Presentation.

Definition at line 119 of file PresentationImpl.java.

◆ isOrderedAccess()

boolean org.opensplice.dds.core.policy.PresentationImpl.isOrderedAccess ( )

If orderedAccess is set, then the accessScope controls the maximum extent for which order will be preserved by the Service.

If accessScope is set to Presentation.AccessScopeKind#INSTANCE (the lowest level), then changes to each instance are considered unordered relative to changes to any other instance. That means that changes (creations, deletions, modifications) made to two instances are not necessarily seen in the order they occur. This is the case even if it is the same application thread making the changes using the same org.omg.dds.pub.DataWriter.
If accessScope is set to Presentation.AccessScopeKind#TOPIC, changes (creations, deletions, modifications) made by a single org.omg.dds.pub.DataWriter are made available to subscribers in the same order they occur. Changes made to instances through different DataWriter entities are not necessarily seen in the order they occur. This is the case, even if the changes are made by a single application thread using DataWriter objects attached to the same org.omg.dds.pub.Publisher.
Finally, if accessScope is set to Presentation.AccessScopeKind#GROUP, changes made to instances via DataWriter entities attached to the same Publisher object are made available to subscribers on the same order they occur.

See also: getAccessScope()

Implements org.omg.dds.core.policy.Presentation.

Definition at line 124 of file PresentationImpl.java.

◆ requestedOfferedContract()

Comparable<Presentation> org.opensplice.dds.core.policy.PresentationImpl.requestedOfferedContract ( )

Definition at line 56 of file PresentationImpl.java.

◆ withAccessScope()

Presentation org.opensplice.dds.core.policy.PresentationImpl.withAccessScope ( AccessScopeKind accessScope )

Copy this policy and override the value of the property.

Parameters

accessScope Specifies the granularity of the changes that needs to be preserved when communicating a set of samples and the granularity of the ordering in which these changes need to be presented to the user.

Returns: a new Presentation policy

Implements org.omg.dds.core.policy.Presentation.

Definition at line 129 of file PresentationImpl.java.

◆ withCoherentAccess()

Presentation org.opensplice.dds.core.policy.PresentationImpl.withCoherentAccess ( boolean coherentAccess )

Copy this policy and override the value of the property.

Parameters

coherentAccess Controls whether the Data Distribution Service will preserve the groupings of changes, as indicated by the access_scope, made by a publishing application by means of the operations begin_coherent_change and end_coherent_change.

Returns: a new Presentation policy

Implements org.omg.dds.core.policy.Presentation.

Definition at line 135 of file PresentationImpl.java.

◆ withGroup()

Presentation org.opensplice.dds.core.policy.PresentationImpl.withGroup ( )

Returns: a new group Presentation policy

Implements org.omg.dds.core.policy.Presentation.

Definition at line 159 of file PresentationImpl.java.

◆ withInstance()

Presentation org.opensplice.dds.core.policy.PresentationImpl.withInstance ( )

Returns: a new instance Presentation policy

Implements org.omg.dds.core.policy.Presentation.

Definition at line 147 of file PresentationImpl.java.

◆ withOrderedAccess()

Presentation org.opensplice.dds.core.policy.PresentationImpl.withOrderedAccess ( boolean orderedAccess )

Copy this policy and override the value of the property.

Parameters

orderedAccess Controls whether the Data Distribution Service will preserve the order of the changes, as indicated by the access_scope.

Returns: a new Presentation policy

Implements org.omg.dds.core.policy.Presentation.

Definition at line 141 of file PresentationImpl.java.

◆ withTopic()

Presentation org.opensplice.dds.core.policy.PresentationImpl.withTopic ( )

Returns: a new topic Presentation policy

Implements org.omg.dds.core.policy.Presentation.

Definition at line 153 of file PresentationImpl.java.

Member Data Documentation

◆ environment

OsplServiceEnvironment org.opensplice.dds.core.policy.QosPolicyImpl.environment

protectedinherited

Definition at line 29 of file QosPolicyImpl.java.

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

java5/common/java/code/org/opensplice/dds/core/policy/PresentationImpl.java

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ PresentationImpl() [1/2]

◆ PresentationImpl() [2/2]

Member Function Documentation

◆ compareTo()

◆ equals()

◆ getAccessScope()

◆ getEnvironment()

◆ getPolicyClass()

◆ hashCode()

◆ isCoherentAccess()

◆ isOrderedAccess()

◆ requestedOfferedContract()

◆ withAccessScope()

◆ withCoherentAccess()

◆ withGroup()

◆ withInstance()

◆ withOrderedAccess()

◆ withTopic()

Member Data Documentation

◆ environment