RDK Documentation (Open Sourced RDK Components)
CCEC_OSAL::Condition Class Reference

#include <Condition.hpp>

Collaboration diagram for CCEC_OSAL::Condition:
Collaboration graph

Public Member Functions

 Condition (void)
 Constructor. Creates an Condition object with state set to false. More...
 
 Condition (bool initial)
 Constructor. Creates an Condition object with state set to given parameter. More...
 
 ~Condition ()
 Destructor. Destroys the Condition object.
 
virtual void set (void)
 Set the state of the object. Sets the state of the object, which will be either true/false. More...
 
virtual bool isSet (void)
 Check the state of the object. Returns the state of the object, which will be either true/false. More...
 
virtual void reset (void)
 Resets the state of the object. Reset the state of object to default, which is set while creating the object. More...
 

Private Attributes

bool initial
 
bool cond
 

yes

This is a simple class which abstract boolean functionality and is used by ConditionVariable class.

Definition at line 52 of file Condition.hpp.

Constructor & Destructor Documentation

◆ Condition() [1/2]

CCEC_OSAL::Condition::Condition ( void  )
inline

Constructor. Creates an Condition object with state set to false.

Definition at line 62 of file Condition.hpp.

◆ Condition() [2/2]

CCEC_OSAL::Condition::Condition ( bool  initial)
inline

Constructor. Creates an Condition object with state set to given parameter.

Parameters
initial- initial state to be set. This will be set as default state of the object as well.

Definition at line 73 of file Condition.hpp.

Member Function Documentation

◆ set()

virtual void CCEC_OSAL::Condition::set ( void  )
inlinevirtual

Set the state of the object. Sets the state of the object, which will be either true/false.

Parameters
cond- state to be set.This will default to true is method called with no parameters.

Definition at line 93 of file Condition.hpp.

◆ isSet()

virtual bool CCEC_OSAL::Condition::isSet ( void  )
inlinevirtual

Check the state of the object. Returns the state of the object, which will be either true/false.

Returns
true if set and false if not set.

Definition at line 103 of file Condition.hpp.

◆ reset()

virtual void CCEC_OSAL::Condition::reset ( void  )
inlinevirtual

Resets the state of the object. Reset the state of object to default, which is set while creating the object.

Definition at line 113 of file Condition.hpp.


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