Public Types | Public Member Functions | Protected Attributes | List of all members
iwiz::CStateControllerCompBase Class Reference

#include <CStateControllerCompBase.h>

Inheritance diagram for iwiz::CStateControllerCompBase:
icomp::CComponentBase iproc::IStateController icomp::IComponent istd::IChangeable istd::IPolymorphic istd::IPolymorphic

Public Types

typedef icomp::CComponentBase BaseClass
 
- Public Types inherited from iproc::IStateController
enum  ChangeFlags { CF_STATE_ENTERED = 0x826710, CF_STATE_LEAVED, CF_GRAPH_CHANGED, CF_STATE_ENABLED }
 Data model change notification flags. More...
 

Public Member Functions

 CStateControllerCompBase ()
 
virtual bool IsStateEnabled () const
 Check if state is enabled. More...
 
virtual bool IsStateActive () const
 Check if this state is active. More...
 
virtual bool IsEnterAllowed (bool isActionAllowed=true, const IStateController *prevStatePtr=NULL) const
 
virtual bool IsLeaveAllowed (bool isActionAllowed=true, const IStateController *nextStatePtr=NULL) const
 
virtual bool TryEnterState (bool isActionAllowed=true, const IStateController *prevStatePtr=NULL)
 
virtual bool TryLeaveState (bool isActionAllowed=true, const IStateController *nextStatePtr=NULL)
 
virtual bool IsResetAllowed () const
 Check if reseting is allowed. More...
 
- Public Member Functions inherited from icomp::IComponent
virtual const ICompositeComponentGetParentComponent (bool ownerOnly=false) const =0
 
virtual void * GetInterface (const istd::CClassInfo &interfaceType, const QByteArray &subId="")=0
 
virtual const IComponentContextGetComponentContext () const =0
 
virtual void SetComponentContext (const icomp::IComponentContext *contextPtr, const ICompositeComponent *parentPtr, bool isParentOwner)=0
 
- Public Member Functions inherited from iproc::IStateController
virtual bool IsEnterAllowed (bool isActionAllowed=true, const IStateController *prevStatePtr=NULL) const =0
 Check if entering of this page is allowed. More...
 
virtual bool IsLeaveAllowed (bool isActionAllowed=true, const IStateController *nextStatePtr=NULL) const =0
 Check if this state can be leaved. More...
 
virtual bool TryEnterState (bool isActionAllowed=true, const IStateController *prevStatePtr=NULL)=0
 Try enter this state. More...
 
virtual bool TryLeaveState (bool isActionAllowed=true, const IStateController *nextStatePtr=NULL)=0
 Try leave this state. More...
 

Protected Attributes

bool m_isStateActive
 
bool m_isStateEnabled
 
bool m_isEnterAllowed
 
bool m_isLeaveAllowed
 

Detailed Description

Definition at line 15 of file CStateControllerCompBase.h.

Member Typedef Documentation

Definition at line 20 of file CStateControllerCompBase.h.

Constructor & Destructor Documentation

iwiz::CStateControllerCompBase::CStateControllerCompBase ( )

Member Function Documentation

virtual bool iwiz::CStateControllerCompBase::IsEnterAllowed ( bool  isActionAllowed = true,
const IStateController *  prevStatePtr = NULL 
) const
virtual
virtual bool iwiz::CStateControllerCompBase::IsLeaveAllowed ( bool  isActionAllowed = true,
const IStateController *  nextStatePtr = NULL 
) const
virtual
virtual bool iwiz::CStateControllerCompBase::IsResetAllowed ( ) const
virtual

Check if reseting is allowed.

See Also
IsEnterAllowed.

Implements iproc::IStateController.

virtual bool iwiz::CStateControllerCompBase::IsStateActive ( ) const
virtual

Check if this state is active.

State is active, if it was succesfully entered and becomes inactive if it was succesfully leaved.

See Also
TryEnterState and TryLeaveState.

Implements iproc::IStateController.

virtual bool iwiz::CStateControllerCompBase::IsStateEnabled ( ) const
virtual

Check if state is enabled.

If state is disabled it will be not considered as a element of transition graph. State is disabled e.g. if some preselection turns it off.

Implements iproc::IStateController.

virtual bool iwiz::CStateControllerCompBase::TryEnterState ( bool  isActionAllowed = true,
const IStateController *  prevStatePtr = NULL 
)
virtual
virtual bool iwiz::CStateControllerCompBase::TryLeaveState ( bool  isActionAllowed = true,
const IStateController *  nextStatePtr = NULL 
)
virtual

Member Data Documentation

bool iwiz::CStateControllerCompBase::m_isEnterAllowed
mutableprotected

Definition at line 41 of file CStateControllerCompBase.h.

bool iwiz::CStateControllerCompBase::m_isLeaveAllowed
mutableprotected

Definition at line 42 of file CStateControllerCompBase.h.

bool iwiz::CStateControllerCompBase::m_isStateActive
mutableprotected

Definition at line 39 of file CStateControllerCompBase.h.

bool iwiz::CStateControllerCompBase::m_isStateEnabled
mutableprotected

Definition at line 40 of file CStateControllerCompBase.h.


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

© 2007-2017 Witold Gantzke and Kirill Lepskiy