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

simulative brake system class for a service brake More...

#include <Simulation.h>

Inheritance diagram for oETCS::DF::PS::SIM::CEmergencyBrake:
Inheritance graph
Collaboration diagram for oETCS::DF::PS::SIM::CEmergencyBrake:
Collaboration graph

Signals

void Error (const ::QString &ErrorMessage)
 signal for sending an error

Public Member Functions

 CEmergencyBrake (const bool &bActive=false) throw ()
 default/general constructor
virtual bool GetActivation ()
 gets the activation state
virtual void SetActivation (bool bActivated)
 sets the activation state
virtual ~CEmergencyBrake () throw ()
 destructor

Private Attributes

bool m_bActive
 activation flag of the emergency brake
::std::recursive_mutex m_Mutex
 muteable exclusion for internal states

Detailed Description

simulative brake system class for a service brake

Definition at line 288 of file Simulation.h.

Constructor & Destructor Documentation

oETCS::DF::PS::SIM::CEmergencyBrake::CEmergencyBrake ( const bool &  bActive = false) throw ()
explicit

default/general constructor

Parameters
[in]bActiveoptional initial emergency activation flag

Definition at line 450 of file Simulation.cpp.

oETCS::DF::PS::SIM::CEmergencyBrake::~CEmergencyBrake ( ) throw ()
virtual

destructor

Reimplemented from oETCS::DF::PS::CEmergencyBrake.

Definition at line 463 of file Simulation.cpp.

Member Function Documentation

void oETCS::DF::CEmergencyBrake::Error ( const ::QString &  ErrorMessage)
signalinherited

signal for sending an error

This signal should be emitted in the case that an error in the HW ocurres.

Parameters
[in]ErrorMessagetextual description of the error

Definition at line 604 of file PlatformSpecificClientsMOC.cpp.

bool oETCS::DF::PS::SIM::CEmergencyBrake::GetActivation ( )
virtual

gets the activation state

Returns
activation flag of the emergency brake

Reimplemented from oETCS::DF::PS::CEmergencyBrake.

Definition at line 474 of file Simulation.cpp.

References m_bActive, and m_Mutex.

Referenced by GetEmergencyActivation(), and oETCS::DF::PS::SIM::CServiceBrake::OdometerThread().

Here is the caller graph for this function:

void oETCS::DF::PS::SIM::CEmergencyBrake::SetActivation ( bool  bActivated)
virtual

sets the activation state

Parameters
[in]bActivatedthe new activation flag

Reimplemented from oETCS::DF::PS::CEmergencyBrake.

Definition at line 499 of file Simulation.cpp.

References m_bActive, and m_Mutex.

Referenced by SetEmergencyActivation().

Here is the caller graph for this function:

Member Data Documentation

bool oETCS::DF::PS::SIM::CEmergencyBrake::m_bActive
private

activation flag of the emergency brake

Definition at line 330 of file Simulation.h.

Referenced by GetActivation(), and SetActivation().

::std::recursive_mutex oETCS::DF::PS::SIM::CEmergencyBrake::m_Mutex
private

muteable exclusion for internal states

Definition at line 337 of file Simulation.h.

Referenced by GetActivation(), and SetActivation().


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