org.omg.dds.type.TypeSupport< TYPE > Class Template Reference

TypeSupport is an abstract interface that has to be specialized for each concrete type that will be used by the application to publish and/or subscribe to data over DDS. More...

Inheritance diagram for org.omg.dds.type.TypeSupport< TYPE >:

Collaboration diagram for org.omg.dds.type.TypeSupport< TYPE >:

Public Member Functions
ServiceEnvironment	getEnvironment ()
abstract Class< TYPE >	getType ()
abstract String	getTypeName ()
abstract TYPE	newData ()

Static Public Member Functions
static< TYPE > TypeSupport< TYPE >	newTypeSupport (Class< TYPE > type, ServiceEnvironment env)
	Create a new TypeSupport object for the given physical type. More...
static< TYPE > TypeSupport< TYPE >	newTypeSupport (Class< TYPE > type, String registeredName, ServiceEnvironment env)
	Create a new TypeSupport object for the given physical type. More...

Detailed Description

TypeSupport is an abstract interface that has to be specialized for each concrete type that will be used by the application to publish and/or subscribe to data over DDS.

Parameters

<TYPE>

The type to be supported for publication and/or subscription.

Definition at line 33 of file TypeSupport.java.

Member Function Documentation

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.

getType()

abstract Class<TYPE> org.omg.dds.type.TypeSupport< TYPE >.getType ( )

abstract

Returns

the class of the type supported by this TypeSupport.

getTypeName()

abstract String org.omg.dds.type.TypeSupport< TYPE >.getTypeName ( )

abstract

Returns

the registered name for the data type represented by the TypeSupport.

newData()

abstract TYPE org.omg.dds.type.TypeSupport< TYPE >.newData ( )

abstract

Returns

a new object of the type supported by this TypeSupport.

newTypeSupport() [1/2]

static <TYPE> TypeSupport<TYPE> org.omg.dds.type.TypeSupport< TYPE >.newTypeSupport ( Class< TYPE >  type, ServiceEnvironment  env  )

static

Create a new TypeSupport object for the given physical type.

This method is equivalent to:

newTypeSupport(type, type.getClass().getName(), bootstrap)

See also

#newTypeSupport(Class, String, ServiceEnvironment)

Definition at line 49 of file TypeSupport.java.

newTypeSupport() [2/2]

static <TYPE> TypeSupport<TYPE> org.omg.dds.type.TypeSupport< TYPE >.newTypeSupport ( Class< TYPE >  type, String  registeredName, ServiceEnvironment  env  )

static

Create a new TypeSupport object for the given physical type.

The Service will register this type under the given name with any participant with which the TypeSupport is used.

Parameters

<TYPE>	The physical type of all samples read or written by any org.omg.dds.sub.DataReader or org.omg.dds.pub.DataWriter typed by the resulting TypeSupport.
type	The physical type of all samples read or written by any org.omg.dds.sub.DataReader or org.omg.dds.pub.DataWriter typed by the resulting TypeSupport.
registeredName	The logical name under which this type will be registered with any org.omg.dds.domain.DomainParticipant with which the resulting TypeSupport is used.
env	Identifies the Service instance to which the new object will belong.

Returns

A new TypeSupport object, which can subsequently be used to create one or more org.omg.dds.topic.Topics.

See also

#newTypeSupport(Class, ServiceEnvironment)

Definition at line 87 of file TypeSupport.java.

---

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

• java5/common/java/code/org/omg/dds/type/TypeSupport.java