openETCS
case study for the European Train Control System developed for the authors dissertation
Public Member Functions | Private Attributes | List of all members
oETCS::DF::CEVCTransition Class Reference

transition class for EVC states More...

#include <EVCStateMachine.h>

Collaboration diagram for oETCS::DF::CEVCTransition:
Collaboration graph

Public Member Functions

 CEVCTransition (oETCS::DF::CEVCCondition *const pCondition, oETCS::DF::CEVCStateMachine::CEVCState *const pStartState, oETCS::DF::CEVCStateMachine::CEVCState *const pTargetState, const unsigned int &iPriority=0) throw ()
 general constructor
const oETCS::DF::CEVCConditionGetCondition () const throw ()
 gets the pointer to the related EVC condition
unsigned int GetPriority () const throw ()
 gets the nurmerial priority
oETCS::DF::CEVCStateMachine::CEVCState
*const 
GetStartState () const throw ()
 gets the pointer to the related EVC start state
oETCS::DF::CEVCStateMachine::CEVCState
*const 
GetTargetState () const throw ()
 gets the pointer to the related EVC target state
virtual ~CEVCTransition () throw ()
 destructor

Private Attributes

const int m_iPriority
 numerical priority of a transition
oETCS::DF::CEVCCondition *const m_pCondition
 pointer to the related condition object
oETCS::DF::CEVCStateMachine::CEVCState
*const 
m_pStartState
 pointer to the EVC start state object of the transition
oETCS::DF::CEVCStateMachine::CEVCState
*const 
m_pTargetState
 pointer to the target state of the transition

Detailed Description

transition class for EVC states

Definition at line 645 of file EVCStateMachine.h.

Constructor & Destructor Documentation

oETCS::DF::CEVCTransition::CEVCTransition ( oETCS::DF::CEVCCondition *const  pCondition,
oETCS::DF::CEVCStateMachine::CEVCState *const  pStartState,
oETCS::DF::CEVCStateMachine::CEVCState *const  pTargetState,
const unsigned int &  iPriority = 0 
) throw ()
explicit

general constructor

Parameterises the EVC state transition with all constant members.

Parameters
[in]pConditonpointer to the related condition object
[in]pStartStatepointer to the start EVC state object of the transtion
[in]pTargetStatepointer to the target EVC state object of the transtion
[in]iPrioritynumerical priority of the transition

Definition at line 1245 of file EVCStateMachine.cpp.

oETCS::DF::CEVCTransition::~CEVCTransition ( ) throw ()
virtual

destructor

Definition at line 1261 of file EVCStateMachine.cpp.

Member Function Documentation

const oETCS::DF::CEVCCondition * oETCS::DF::CEVCTransition::GetCondition ( ) const throw ()

gets the pointer to the related EVC condition

Returns
pointer to the related EVC condition object

Definition at line 1272 of file EVCStateMachine.cpp.

unsigned int oETCS::DF::CEVCTransition::GetPriority ( ) const throw ()

gets the nurmerial priority

Returns
the numerical priority

Definition at line 1308 of file EVCStateMachine.cpp.

oETCS::DF::CEVCStateMachine::CEVCState *const oETCS::DF::CEVCTransition::GetStartState ( ) const throw ()

gets the pointer to the related EVC start state

Returns
pointer to the related EVC start state object

Definition at line 1284 of file EVCStateMachine.cpp.

oETCS::DF::CEVCStateMachine::CEVCState *const oETCS::DF::CEVCTransition::GetTargetState ( ) const throw ()

gets the pointer to the related EVC target state

Returns
pointer to the related EVC target state object

Definition at line 1296 of file EVCStateMachine.cpp.

Member Data Documentation

const int oETCS::DF::CEVCTransition::m_iPriority
private

numerical priority of a transition

Definition at line 731 of file EVCStateMachine.h.

oETCS::DF::CEVCCondition* const oETCS::DF::CEVCTransition::m_pCondition
private

pointer to the related condition object

Definition at line 710 of file EVCStateMachine.h.

oETCS::DF::CEVCStateMachine::CEVCState* const oETCS::DF::CEVCTransition::m_pStartState
private

pointer to the EVC start state object of the transition

Definition at line 717 of file EVCStateMachine.h.

oETCS::DF::CEVCStateMachine::CEVCState* const oETCS::DF::CEVCTransition::m_pTargetState
private

pointer to the target state of the transition

Definition at line 724 of file EVCStateMachine.h.


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

Copyright (C) 2010-2012 Johannes Feuser (feuser@uni-bremen.de)
The openETCS library is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or any later version.
The openETCS library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along with the openETCS library. If not, see "http://www.gnu.org/licenses/.