OpenSplice Java 5 DCPS  v6.x
OpenSplice Java 5 OpenSplice Data Distribution Service Data-Centric Publish-Subscribe API
org.opensplice.dds.core.DomainEntityImpl< OLD extends DDS.Entity, PARENT extends EntityImpl<?, ?, ?, ?, ?, OLDPARENT extends DDS.Entity, QOS extends EntityQos<?, LISTENER extends EventListener, LISTENERIMPL extends Listener< LISTENER > Class Template Referenceabstract
Inheritance diagram for org.opensplice.dds.core.DomainEntityImpl< OLD extends DDS.Entity, PARENT extends EntityImpl<?, ?, ?, ?, ?, OLDPARENT extends DDS.Entity, QOS extends EntityQos<?, LISTENER extends EventListener, LISTENERIMPL extends Listener< LISTENER >:
Inheritance graph
Collaboration diagram for org.opensplice.dds.core.DomainEntityImpl< OLD extends DDS.Entity, PARENT extends EntityImpl<?, ?, ?, ?, ?, OLDPARENT extends DDS.Entity, QOS extends EntityQos<?, LISTENER extends EventListener, LISTENERIMPL extends Listener< LISTENER >:
Collaboration graph

Public Member Functions

 DomainEntityImpl (OsplServiceEnvironment environment, PARENT parent, OLDPARENT oldParent)
 
final void close ()
 
final void enable ()
 
ServiceEnvironment getEnvironment ()
 
final InstanceHandle getInstanceHandle ()
 
final LISTENER getListener ()
 
OLD getOld ()
 
OLDPARENT getOldParent ()
 
Entity<?, ?> getParent ()
 
String getProperty (String key)
 Provides access to the current value for a given property. More...
 
final Set< Class<? extends Status > > getStatusChanges ()
 
final void retain ()
 
void setProperty (String key, String value)
 This method sets the property specified by the key to the value given by the value. More...
 

Static Public Member Functions

static boolean printReferences ()
 

Protected Member Functions

abstract void destroy ()
 
void setOld (OLD old)
 

Protected Attributes

final transient OsplServiceEnvironment environment
 
LISTENERIMPL listener
 
PARENT parent
 

Detailed Description

Definition at line 27 of file DomainEntityImpl.java.

Constructor & Destructor Documentation

◆ DomainEntityImpl()

org.opensplice.dds.core.DomainEntityImpl< OLD extends DDS.Entity, PARENT extends EntityImpl<?, ?, ?, ?, ?, OLDPARENT extends DDS.Entity, QOS extends EntityQos<?, LISTENER extends EventListener, LISTENERIMPL extends Listener< LISTENER >.DomainEntityImpl ( OsplServiceEnvironment  environment,
PARENT  parent,
OLDPARENT  oldParent 
)

Definition at line 42 of file DomainEntityImpl.java.

Member Function Documentation

◆ close()

final void org.opensplice.dds.core.EntityImpl< OLD extends DDS.Entity, OLDPARENT, QOS extends EntityQos<?, LISTENER extends EventListener, LISTENERIMPL extends Listener< LISTENER >.close ( )
inherited

Definition at line 139 of file EntityImpl.java.

◆ destroy()

abstract void org.opensplice.dds.core.EntityImpl< OLD extends DDS.Entity, OLDPARENT, QOS extends EntityQos<?, LISTENER extends EventListener, LISTENERIMPL extends Listener< LISTENER >.destroy ( )
abstractprotectedinherited

◆ enable()

final void org.opensplice.dds.core.EntityImpl< OLD extends DDS.Entity, OLDPARENT, QOS extends EntityQos<?, LISTENER extends EventListener, LISTENERIMPL extends Listener< LISTENER >.enable ( )
inherited

Definition at line 153 of file EntityImpl.java.

◆ getEnvironment()

ServiceEnvironment org.opensplice.dds.core.EntityImpl< OLD extends DDS.Entity, OLDPARENT, QOS extends EntityQos<?, LISTENER extends EventListener, LISTENERIMPL extends Listener< LISTENER >.getEnvironment ( )
inherited

Definition at line 121 of file EntityImpl.java.

◆ getInstanceHandle()

final InstanceHandle org.opensplice.dds.core.EntityImpl< OLD extends DDS.Entity, OLDPARENT, QOS extends EntityQos<?, LISTENER extends EventListener, LISTENERIMPL extends Listener< LISTENER >.getInstanceHandle ( )
inherited

Definition at line 166 of file EntityImpl.java.

◆ getListener()

final LISTENER org.opensplice.dds.core.EntityImpl< OLD extends DDS.Entity, OLDPARENT, QOS extends EntityQos<?, LISTENER extends EventListener, LISTENERIMPL extends Listener< LISTENER >.getListener ( )
inherited

Definition at line 174 of file EntityImpl.java.

◆ getOld()

OLD org.opensplice.dds.core.EntityImpl< OLD extends DDS.Entity, OLDPARENT, QOS extends EntityQos<?, LISTENER extends EventListener, LISTENERIMPL extends Listener< LISTENER >.getOld ( )
inherited

Definition at line 102 of file EntityImpl.java.

◆ getOldParent()

OLDPARENT org.opensplice.dds.core.EntityImpl< OLD extends DDS.Entity, OLDPARENT, QOS extends EntityQos<?, LISTENER extends EventListener, LISTENERIMPL extends Listener< LISTENER >.getOldParent ( )
inherited

Definition at line 116 of file EntityImpl.java.

◆ getParent()

Entity<?, ?> org.omg.dds.core.DomainEntity< LISTENER extends EventListener, QOS extends EntityQos<?>.getParent ( )
inherited
Returns
the factory object that created this entity.

◆ getProperty()

String org.opensplice.dds.core.EntityImpl< OLD extends DDS.Entity, OLDPARENT, QOS extends EntityQos<?, LISTENER extends EventListener, LISTENERIMPL extends Listener< LISTENER >.getProperty ( String  key)
inherited

Provides access to the current value for a given property.

Parameters
keyThe key of the property to obtain the value for.
Returns
The value for the specified property, or null if it has not been set.

Definition at line 189 of file EntityImpl.java.

◆ getStatusChanges()

final Set<Class<? extends Status> > org.opensplice.dds.core.EntityImpl< OLD extends DDS.Entity, OLDPARENT, QOS extends EntityQos<?, LISTENER extends EventListener, LISTENERIMPL extends Listener< LISTENER >.getStatusChanges ( )
inherited

Definition at line 160 of file EntityImpl.java.

◆ printReferences()

static boolean org.opensplice.dds.core.EntityImpl< OLD extends DDS.Entity, OLDPARENT, QOS extends EntityQos<?, LISTENER extends EventListener, LISTENERIMPL extends Listener< LISTENER >.printReferences ( )
staticinherited

Definition at line 66 of file EntityImpl.java.

◆ retain()

final void org.opensplice.dds.core.EntityImpl< OLD extends DDS.Entity, OLDPARENT, QOS extends EntityQos<?, LISTENER extends EventListener, LISTENERIMPL extends Listener< LISTENER >.retain ( )
inherited

Definition at line 126 of file EntityImpl.java.

◆ setOld()

void org.opensplice.dds.core.EntityImpl< OLD extends DDS.Entity, OLDPARENT, QOS extends EntityQos<?, LISTENER extends EventListener, LISTENERIMPL extends Listener< LISTENER >.setOld ( OLD  old)
protectedinherited

Definition at line 112 of file EntityImpl.java.

◆ setProperty()

void org.opensplice.dds.core.EntityImpl< OLD extends DDS.Entity, OLDPARENT, QOS extends EntityQos<?, LISTENER extends EventListener, LISTENERIMPL extends Listener< LISTENER >.setProperty ( String  key,
String  value 
)
inherited

This method sets the property specified by the key to the value given by the value.

Currently, this method is only supported on a org.omg.dds.sub.DataReader and that supports the following properties:

parallelReadThreadCount - By default, the demarshalling of data into Java objects by a single read or take operation happens only in the calling thread. The parallelReadThreadCount property can be used to control the number of parallel threads to be used for this demarshalling. When reading multiple of samples takes a significant amount of time, increasing the number of threads on a multi-core machine can provide a significant benefit. The value is interpreted as the number of parallel threads to use (i.e., the value is a string representing a natural integer in decimal notation, so for example the string '4' will cause 4 threads to be used). The value '0' is allowed and selects the default behavior. If the call was successful, successive read/take operations on that org.omg.dds.sub.DataReader will use the specified number of threads for the demarshalling step of the respective operations until the value of this property is changed again.

CDRCopy - The default demarshalling technique constructs the Java object directly from the shared memory, but for some types, it is more efficient to marshal the value in shared memory into CDR representation, and then demarshal the CDR representation from Java. The value is interpreted as a boolean (i.e., value must be either 'true' or 'false'), with 'false' selecting the default technique and 'true' selecting the alternative, CDR-based technique. The CDR-based technique requires JacORB to be configured as the default ORB in the JVM, and furthermore requires that the JacORB IDL preprocessor has been used to generate a Helper class for the topic type of this org.omg.dds.sub.DataReader and that this helper class can be found in the class path. The ORB initialization and Helper class lookup is all done at run-time to avoid introducing a compile-time dependency, but this means that attempting to set the CDRCopy property to 'true' can fail in complicated ways because of these dependencies. When set to true, the CDR-based technique will be used for successive read/take operations on the data reader, until the property is set to false again.

Parameters
keyThe key of the property
valueThe value to assign to the property.

Definition at line 182 of file EntityImpl.java.

Member Data Documentation

◆ environment

final transient OsplServiceEnvironment org.opensplice.dds.core.EntityImpl< OLD extends DDS.Entity, OLDPARENT, QOS extends EntityQos<?, LISTENER extends EventListener, LISTENERIMPL extends Listener< LISTENER >.environment
protectedinherited

Definition at line 36 of file EntityImpl.java.

◆ listener

LISTENERIMPL org.opensplice.dds.core.EntityImpl< OLD extends DDS.Entity, OLDPARENT, QOS extends EntityQos<?, LISTENER extends EventListener, LISTENERIMPL extends Listener< LISTENER >.listener
protectedinherited

Definition at line 39 of file EntityImpl.java.

◆ parent

PARENT org.opensplice.dds.core.DomainEntityImpl< OLD extends DDS.Entity, PARENT extends EntityImpl<?, ?, ?, ?, ?, OLDPARENT extends DDS.Entity, QOS extends EntityQos<?, LISTENER extends EventListener, LISTENERIMPL extends Listener< LISTENER >.parent
protected

Definition at line 40 of file DomainEntityImpl.java.


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