DDS.EntityFactoryQosPolicy Struct Reference

More...

Collaboration diagram for DDS.EntityFactoryQosPolicy:

Public Attributes
bool	AutoEnableCreatedEntities

Detailed Description

This QosPolicy controls the behaviour of the Entity as a factory for other entities.

Attributes

Value	Meaning	Concerns	RxO	Changeable
A boolean: autoenable_created_entities	Specifies whether the entity acting as a factory automatically enables the instances it creates. If autoenable_created_ entities==TRUE, the factory will automatically enable each created Entity otherwise it will not. By default, TRUE.	DomainParticipant, Publisher, Subscriber	No	Yes

This policy controls the behaviour of the Entity as a factory for other entities. This policy concerns only DomainParticipant (as factory for Publisher, Subscriber, and Topic), Publisher (as factory for DataWriter), and Subscriber (as factory for 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 autoenable_created_entities to TRUE indicates that the factory create_<entity> operation will automatically invoke the 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 autoenable_created_entities = TRUE means that, by default, it is not necessary to explicitly call enable on newly created entities.

Definition at line 1391 of file DdsDcpsStructs.cs.

Member Data Documentation

AutoEnableCreatedEntities

bool DDS.EntityFactoryQosPolicy.AutoEnableCreatedEntities

Definition at line 1394 of file DdsDcpsStructs.cs.

---

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

• src/api/dcps/sacs/code/DDS/DdsDcpsStructs.cs