Controls the behavior of the org.omg.dds.core.Entity when acting as a factory for other entities. More...

Inheritance diagram for org.omg.dds.core.policy.EntityFactory:

Collaboration diagram for org.omg.dds.core.policy.EntityFactory:

Public Member Functions
ServiceEnvironment	getEnvironment ()

boolean	isAutoEnableCreatedEntities ()

EntityFactory	withAutoEnableCreatedEntities (boolean autoEnableCreatedEntities)
	Copy this policy and override the value of the property. More...

Detailed Description

Controls the behavior of the org.omg.dds.core.Entity when acting as a factory for other entities.

In other words, configures the side-effects of the create_* operations.

Concerns: org.omg.dds.domain.DomainParticipantFactory, org.omg.dds.domain.DomainParticipant, org.omg.dds.pub.Publisher, org.omg.dds.sub.Subscriber

RxO: No

Changeable: Yes

This policy controls the behavior of the Entity as a factory for other entities.

This policy concerns only DomainParticipant (as factory for Publisher, Subscriber, and org.omg.dds.topic.Topic), Publisher (as factory for org.omg.dds.pub.DataWriter), and Subscriber (as factory for org.omg.dds.sub.DataReader).

This policy is mutable. A change in the policy affects only the entities created after the change; not the previously created entities.

The setting of autoenableCreatedEntities to true indicates that the factory create<entity> operation will automatically invoke the org.omg.dds.core.Entity#enable() operation each time a new Entity is created. Therefore, the Entity returned by create<entity> will already be enabled. A setting of false indicates that the Entity will not be automatically enabled. The application will need to enable it explicitly by means of the enable operation.

The default setting of autoenableCreatedEntities = true means that, by default, it is not necessary to explicitly call enable on newly created entities.

Definition at line 58 of file EntityFactory.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.

◆ isAutoEnableCreatedEntities()

boolean org.omg.dds.core.policy.EntityFactory.isAutoEnableCreatedEntities ( )

Returns: the autoEnableCreatedEntities

Implemented in org.opensplice.dds.core.policy.EntityFactoryImpl.

◆ withAutoEnableCreatedEntities()

EntityFactory org.omg.dds.core.policy.EntityFactory.withAutoEnableCreatedEntities ( boolean autoEnableCreatedEntities )

Copy this policy and override the value of the property.

Parameters

autoEnableCreatedEntities Specifies whether the entity acting as a factory automatically enables the instances it creates. If autoEnableCreatedEntities is true the factory will automatically enable each created Entity, otherwise it will not.

Returns: a new EntityFactory policy