dds::core::cond::Condition Class Reference

This class is the base class for all the conditions that may be attached to a dds::core::cond::WaitSet. More...

#include "Condition.hpp"

Inherits dds::core::Reference< DELEGATE >.

Inherited by dds::core::cond::GuardCondition, dds::core::cond::StatusCondition, and dds::sub::cond::ReadCondition.

Public Member Functions
void	dispatch ()
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

This class is the base class for all the conditions that may be attached to a dds::core::cond::WaitSet.

This base class is specialized in three classes by the Data Distribution Service:

• dds::core::cond::GuardCondition
• dds::core::cond::StatusCondition
• dds::sub::cond::ReadCondition
  • dds::sub::cond::QueryCondition

Each Condition has a trigger_value that can be TRUE or FALSE and is set by the Data Distribution Service (except a GuardCondition) depending on the evaluation of the Condition.

See also

Status concept

WaitSet concept

Definition at line 58 of file Condition.hpp.

Member Function Documentation

dispatch()

void dds::core::cond::Condition::dispatch

(

)

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

handler() [1/2]

template<typename Functor >

void dds::core::cond::Condition::handler

(

const Functor &

func

)

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

)

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

(

)

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

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/Condition.hpp