dds::core::policy::EntityFactory Class Reference

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

Public Member Functions
	EntityFactory (bool auto_enable=true)
	Construct an entity factory with specified autoenable flag. More...
	EntityFactory (const EntityFactory &other)
	Copy constructor.
EntityFactory &	autoenable_created_entities (bool on)
	Modify the autoenable flag.
bool	autoenable_created_entities () const
	Access the autoenable flag.

Static Public Member Functions
static EntityFactory	AutoEnable ()
	Helper to construct an instance with autoenable = true.
static EntityFactory	ManuallyEnable ()
	Helper to construct an instance with autoenable = false.

Detailed Description

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 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 newly created object will be enabled by default. 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 (see Section 7.1.2.1.1.7, "enable"). The default setting of autoenable_created_entities = TRUE means that, by default, it is not necessary to explicitly call enable on newly created entities.

Constructor & Destructor Documentation

EntityFactory()

dds::core::policy::EntityFactory::EntityFactory ( bool  auto_enable = true )

explicit

Construct an entity factory with specified autoenable flag.

The default autoenable value is true.