A StatusCondition object is a specific Condition that is associated with each Entity. More...

#include "StatusCondition.hpp"

Public Member Functions
	StatusCondition (const dds::core::Entity &e)

template<typename FUN >
	StatusCondition (const dds::core::Entity &e, const FUN &functor)

template<typename FUN >
	StatusCondition (const dds::core::Entity &e, FUN &functor)

void	dispatch ()

const ::dds::core::status::StatusMask	enabled_statuses () const

void	enabled_statuses (const ::dds::core::status::StatusMask &status) const

const dds::core::Entity &	entity () const

template<typename Functor >
void	handler (const Functor &func)

template<typename Functor >
void	handler (Functor &func)

bool	is_nil () const

bool	operator!= (const null_type nil) const

template<typename R >
bool	operator!= (const R &ref) const

DELEGATE *	operator-> ()

const DELEGATE *	operator-> () const

bool	operator== (const null_type) const

template<typename R >
bool	operator== (const R &ref) const

void	reset_handler ()

bool	trigger_value () const

Detailed Description

A StatusCondition object is a specific Condition that is associated with each Entity.

Entity objects that have status attributes also have a StatusCondition, access is provided to the application by the get_statuscondition operation. The communication statuses whose changes can be communicated to the application depend on the Entity. The following table shows the relevant statuses for each Entity.

Entity	Status Name
dds::topic::Topic	dds::core::status::StatusMask::inconsistent_topic()
dds::sub::Subscriber	dds::core::status::StatusMask::data_on_readers()
dds::sub::DataReader	dds::core::status::StatusMask::sample_rejected() dds::core::status::StatusMask::liveliness_changed() dds::core::status::StatusMask::requested_deadline_missed() dds::core::status::StatusMask::requested_incompatible_qos() dds::core::status::StatusMask::data_available() dds::core::status::StatusMask::sample_lost() dds::core::status::StatusMask::subscription_matched()
dds::pub::DataWriter	dds::core::status::StatusMask::liveliness_lost() dds::core::status::StatusMask::offered_deadline_missed() dds::core::status::StatusMask::offered_incompatible_qos() dds::core::status::StatusMask::publication_matched()

The inherited dds::core::cond::Condition::trigger_value() of the StatusCondition depends on the communication statuses of that Entity (e.g., missed deadline) and also depends on the value of the dds::core::status::StatusMask.

A StatusCondition can be attached to a WaitSet in order to allow an application to suspend until the trigger_value has become TRUE.

The trigger_value of a StatusCondition will be TRUE if one of the enabled StatusChangedFlags is set. That is, trigger_value==FALSE only if all the values of the StatusChangedFlags are FALSE.

The sensitivity of the StatusCondition to a particular communication status is controlled by the list of enabled_statuses set on the condition by means of dds::core::cond::StatusCondition::enabled_statuses(const ::dds::core::status::StatusMask& status) When the enabled_statuses are not changed by that operation, all statuses are enabled by default.

See the WaitSet examples for examples how to use this Condition.

See also: dds::core::cond::Condition; Status concept; WaitSet concept; WaitSet examples

Definition at line 82 of file StatusCondition.hpp.

Constructor & Destructor Documentation

◆ StatusCondition() [1/3]

dds::core::cond::StatusCondition::StatusCondition ( const dds::core::Entity & e )

Create a dds::core::cond::StatusCondition associated with an Entity.

The StatusCondition can then be added to a dds::core::cond::WaitSet so that the application can wait for specific status changes that affect the Entity.

Parameters

e	The Entity to associate with the StatusCondition.

Exceptions

dds::core::Exception

◆ StatusCondition() [2/3]

template<typename FUN >

dds::core::cond::StatusCondition::StatusCondition	(	const dds::core::Entity &	e,
		FUN &	functor
	)

Create a dds::core::cond::StatusCondition associated with an Entity.

The StatusCondition can then be added to a dds::core::cond::WaitSet so that the application can wait for specific status changes that affect the Entity.

The supplied functor will be called when this StatusCondition is triggered and either the inherited dds::core::cond::Condition::dispatch() is called or the dds::core::cond::WaitSet::dispatch() on the WaitSet to which this StatusCondition is attached to.

Parameters

e	The Entity to associate with the StatusCondition.

Template Parameters

functor The functor to be called when the StatusCondition triggers.

Exceptions

dds::core::Exception

◆ StatusCondition() [3/3]

template<typename FUN >

dds::core::cond::StatusCondition::StatusCondition	(	const dds::core::Entity &	e,
		const FUN &	functor
	)

Create a dds::core::cond::StatusCondition associated with an Entity.

The StatusCondition can then be added to a dds::core::cond::WaitSet so that the application can wait for specific status changes that affect the Entity.

The supplied functor will be called when this StatusCondition is triggered and either the inherited dds::core::cond::Condition::dispatch() is called or the dds::core::cond::WaitSet::dispatch() on the WaitSet to which this StatusCondition is attached to.

Parameters

e	The Entity to associate with the StatusCondition.

Template Parameters

functor The functor to be called when the StatusCondition triggers.

Exceptions

dds::core::Exception

Member Function Documentation

◆ dispatch()

void dds::core::cond::Condition::dispatch ( )

inherited

Dispatches the functor that have been registered with the Condition.

The Condition has to have been triggered for the functor will be called by this function.

Returns: void

Exceptions

dds::core::Exception

◆ enabled_statuses() [1/2]

const ::dds::core::status::StatusMask dds::core::cond::StatusCondition::enabled_statuses ( ) const

This operation returns the list of enabled communication statuses of the StatusCondition.

The inherited dds::core::cond::Condition::trigger_value() of the StatusCondition depends on the communication status of that Entity (e.g., missed deadline, loss of information, etc.), ‘filtered’ by the set of enabled_statuses on the StatusCondition.

This operation returns the list of communication statuses that are taken into account to determine the trigger_value of the StatusCondition. This operation returns the statuses that were explicitly set on the last call to dds::core::cond::StatusCondition::enabled_statuses(const ::dds::core::status::StatusMask& status) const or, if enabled_statuses(status) was never called, the default list.

The result value is a bit mask in which each bit shows which value has changed. The relevant bits represent one of the following statuses:

Each status bit is declared as a constant and can be used in an AND operation to check the status bit against the result of type StatusMask. Not all statuses are relevant to all Entity objects. See the respective Listener interfaces for each Entity for more information.

Returns: dds::core::status::StatusMask A bit mask in which each bit shows which status is taken into account for the StatusCondition.

Exceptions

dds::core::Exception

◆ enabled_statuses() [2/2]

void dds::core::cond::StatusCondition::enabled_statuses ( const ::dds::core::status::StatusMask & status ) const

This operation sets the list of communication statuses that are taken into account to determine the trigger_value of the StatusCondition.

The inherited dds::core::cond::Condition::trigger_value() of the StatusCondition depends on the communication status of that Entity (e.g., missed deadline, loss of information, etc.), ‘filtered’ by the set of enabled_statuses on the StatusCondition.

This operation sets the list of communication statuses that are taken into account to determine the trigger_value of the StatusCondition. This operation may change the trigger_value of the StatusCondition.

dds::core::cond::WaitSet objects behaviour depend on the changes of the trigger_value of their attached Conditions. Therefore, any WaitSet to which the StatusCondition is attached is potentially affected by this operation. If this function is not invoked, the default list of enabled_statuses includes all the statuses.

The result value is a bit mask in which each bit shows which value has changed. The relevant bits represent one of the following statuses:

Each status bit is declared as a constant and can be used in an AND operation to check the status bit against the result of type StatusMask. Not all statuses are relevant to all Entity objects. See the respective Listener interfaces for each Entity for more information.

Parameters

status A bit mask in which each bit sets the status which is taken into account for the StatusCondition.the enabled statuses.

Returns: void

Exceptions

dds::core::AlreadyClosedError
dds::core::Error

◆ entity()

const dds::core::Entity& dds::core::cond::StatusCondition::entity ( ) const

This operation returns the Entity associated with the StatusCondition

Note that there is exactly one Entity associated with each StatusCondition.

Returns: dds::core::Entity The Entity associated with the StatusCondition.

Exceptions

dds::core::AlreadyClosedError

◆ handler() [1/2]

template<typename Functor >

void dds::core::cond::Condition::handler ( const Functor & func )

inherited

Registers a functor as custom handler with this Condition.

The supplied functor will be called when this Condition is triggered and either the dds::core::cond::Condition::dispatch() is called or the dds::core::cond::WaitSet::dispatch() on the WaitSet to which this Condition is attached to.

Template Parameters

Functor The functor to be called when the StatusCondition triggers.

Returns: void

Exceptions

dds::core::Exception

◆ handler() [2/2]

template<typename Functor >

void dds::core::cond::Condition::handler ( Functor & func )

inherited

Registers a functor as custom handler with this Condition.

The supplied functor will be called when this Condition is triggered and either the dds::core::cond::Condition::dispatch() is called or the dds::core::cond::WaitSet::dispatch() on the WaitSet to which this Condition is attached to.

Template Parameters

Functor The functor to be called when the StatusCondition triggers.

Returns: void

Exceptions

dds::core::Exception

◆ is_nil()

template<typename DELEGATE>

bool dds::core::Reference< DELEGATE >::is_nil ( ) const

inherited

Check if the referenced object is nil.

In other words, check if the reference is pointing to a null object.

Returns: true if the referenced object is null.

◆ operator!=() [1/2]

template<typename DELEGATE>

bool dds::core::Reference< DELEGATE >::operator!= ( const null_type nil ) const

inherited

Special operator!= used to check if this reference object does not equal the dds::core::null reference.

The non-null-check can be done like this:

if (r != dds::core::null) {
   // Use the dds reference object r
}

Returns: true if this reference is not null.

◆ operator!=() [2/2]

template<typename DELEGATE>

template<typename R >

bool dds::core::Reference< DELEGATE >::operator!= ( const R & ref ) const

inherited

Compares two Reference objects and returns true if they are not equal.

Inequality is based on the referential inequality of the object being pointed to.

Parameters

ref	the other Reference object

Returns: true when not equal

◆ operator->() [1/2]

template<typename DELEGATE>

DELEGATE* dds::core::Reference< DELEGATE >::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 Reference and on all its subclasses as follows:

my_dds_entity.standard_function();

my_dds_entity->vendor_specific_extension();

Returns: a reference to delegate.

◆ operator->() [2/2]

template<typename DELEGATE>

const DELEGATE* dds::core::Reference< DELEGATE >::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 Reference and on all its subclasses as follows:

my_dds_entity.standard_function();

my_dds_entity->vendor_specific_extension();

Returns: a reference to delegate.

◆ operator==() [1/2]

template<typename DELEGATE>

bool dds::core::Reference< DELEGATE >::operator== ( const null_type ) const

inherited

Special operator== used to check if this reference object equals the dds::core::null reference.

The null-check can be done like this:

if (r == dds::core::null) {
   // Do not use the dds reference object r in its current state
}

Returns: true if this reference is null.

◆ operator==() [2/2]

template<typename DELEGATE>

template<typename R >

bool dds::core::Reference< DELEGATE >::operator== ( const R & ref ) const

inherited

Compares two Reference objects and returns true if they are equal.

Equality is based on the referential equality of the object being pointed.

Parameters

ref	the other Reference object

Returns: true when equal

◆ reset_handler()

void dds::core::cond::Condition::reset_handler ( )

inherited

Resets the handler for this Condition.

After the invocation of this function no handler will be registered with this Condition.

Returns: void

Exceptions

dds::core::Exception

◆ trigger_value()

bool dds::core::cond::Condition::trigger_value ( ) const

inherited

This operation retrieves the trigger_value of the Condition.

A Condition has a trigger_value that can be TRUE or FALSE and is set by the Data Distribution Service (except a GuardCondition). This operation returns the trigger_value of the Condition.

Returns: bool The boolean value to which the Condition is set.

Exceptions

dds::core::Exception

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

dds/core/cond/StatusCondition.hpp

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ StatusCondition() [1/3]

◆ StatusCondition() [2/3]

◆ StatusCondition() [3/3]

Member Function Documentation

◆ dispatch()

◆ enabled_statuses() [1/2]

◆ enabled_statuses() [2/2]

◆ entity()

◆ handler() [1/2]

◆ handler() [2/2]

◆ is_nil()

◆ operator!=() [1/2]

◆ operator!=() [2/2]

◆ operator->() [1/2]

◆ operator->() [2/2]

◆ operator==() [1/2]

◆ operator==() [2/2]

◆ reset_handler()

◆ trigger_value()