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

More...

#include "CorePolicy.hpp"

Inheritance diagram for dds::core::policy::EntityFactory:

Public Member Functions
	EntityFactory (bool autoenable_created_entities=true)
	EntityFactory (const EntityFactory &other)
EntityFactory &	autoenable_created_entities (bool autoenable_created_entities)
bool	autoenable_created_entities () const
bool	operator!= (const Value &other) const
D *	operator-> ()
const D *	operator-> () const
bool	operator== (const Value &other) const

Static Public Member Functions
static EntityFactory	AutoEnable ()
static EntityFactory	ManuallyEnable ()

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 276 of file CorePolicy.hpp.

Constructor & Destructor Documentation

EntityFactory() [1/2]

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

explicit

Creates an EntityFactory QoS instance

Parameters

autoenable_created_entities

boolean indicating whether created Entities should be automatically enabled

Definition at line 283 of file CorePolicyImpl.hpp.

EntityFactory() [2/2]

dds::core::policy::EntityFactory::EntityFactory

(

const EntityFactory &

other

)

Copies an EntityFactory QoS instance

Parameters

other

the EntityFactory QoS instance to copy

Definition at line 286 of file CorePolicyImpl.hpp.

Member Function Documentation

AutoEnable()

EntityFactory dds::core::policy::EntityFactory::AutoEnable ( )

static

Returns

an EntityFactory QoS instance with autoenable_created_entities set to true

Definition at line 302 of file CorePolicyImpl.hpp.

autoenable_created_entities() [1/2]

EntityFactory & dds::core::policy::EntityFactory::autoenable_created_entities

(

bool

autoenable_created_entities

)

Sets a boolean indicating whether created Entities should be automatically enabled

Parameters

autoenable_created_entities

boolean indicating whether created Entities should be automatically enabled

Definition at line 289 of file CorePolicyImpl.hpp.

autoenable_created_entities() [2/2]

bool dds::core::policy::EntityFactory::autoenable_created_entities

(

)

const

Gets a boolean indicating whether Entities should be automatically enabled

Returns

boolean indicating whether created Entities should be automatically enabled

Definition at line 296 of file CorePolicyImpl.hpp.

ManuallyEnable()

EntityFactory dds::core::policy::EntityFactory::ManuallyEnable ( )

static

Returns

an EntityFactory QoS instance with autoenable_created_entities set to false

Definition at line 308 of file CorePolicyImpl.hpp.

operator!=()

template<typename D >

bool dds::core::Value< D >::operator!= ( const Value< D > &  other ) const

inherited

Compare this Value with another Value

Parameters

other

Value

Returns

true if not equal

Definition at line 99 of file Value.hpp.

operator->() [1/2]

template<typename D >

D * dds::core::Value< D >::operator-> ( )

inherited

The operator->() is provided to be able to directly invoke functions on the delegate.

The decision to provide direct access to the delegate was motivated by the need for providing a way that was not invasive with respect to the CXXDDS API and yet would allow for vendor-specific extension. Thus vendor-specific extensions can be invoked on the Value and on all its subclasses as follows:

my_dds_value.standard_function();
my_dds_value->vendor_specific_extension();

Returns

a reference to delegate.

Definition at line 111 of file Value.hpp.

operator->() [2/2]

template<typename D >

const D * dds::core::Value< D >::operator-> ( ) const

inherited

The operator->() is provided to be able to directly invoke functions on the delegate.

The decision to provide direct access to the delegate was motivated by the need for providing a way that was not invasive with respect to the CXXDDS API and yet would allow for vendor-specific extension. Thus vendor-specific extensions can be invoked on the Value and on all its subclasses as follows:

my_dds_value.standard_function();
my_dds_value->vendor_specific_extension();

Returns

a reference to delegate.

Definition at line 105 of file Value.hpp.

operator==()

template<typename D >

bool dds::core::Value< D >::operator== ( const Value< D > &  other ) const

inherited

Compare this Value with another Value

Parameters

other

Value

Returns

true if equal

Definition at line 93 of file Value.hpp.

---

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

• include/dcps/C++/isocpp2/dds/core/policy/CorePolicy.hpp
• include/dcps/C++/isocpp2/dds/core/policy/detail/CorePolicyImpl.hpp