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

empty/stub class for the ::oETCS::DF::AEmergencyBrake adapter More...

#include <AdaptorStubsMOC.h>

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

Public Slots

virtual bool GetActivation ()
 gets the activation state
virtual void SetActivation (bool bActivated)
 sets the activation state

Signals

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

Public Member Functions

 CEmergencyBrake (::QObject *const pParent=nullptr) throw ()
 default/general constructor
virtual ~CEmergencyBrake () throw ()
 destructor

Detailed Description

empty/stub class for the ::oETCS::DF::AEmergencyBrake adapter

This class is meant to be extened for any certain in emergency brake device implementation.

Definition at line 173 of file AdaptorStubsMOC.h.

Constructor & Destructor Documentation

oETCS::DF::PS::CEmergencyBrake::CEmergencyBrake ( ::QObject *const  pParent = nullptr) throw ()

default/general constructor

Parameters
[in]pParentoptional pointer to a parent object, must be used, if stub is exetened by inheritance

Definition at line 95 of file AdaptorStubsMOC.cpp.

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

destructor

Reimplemented in oETCS::DF::PS::SIM::CEmergencyBrake.

Definition at line 107 of file AdaptorStubsMOC.cpp.

Member Function Documentation

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

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::CEmergencyBrake::GetActivation ( )
virtualslot

gets the activation state

This method should be reimplemented or extened for a concrete HW device.

Returns
activation flag of the emergency brake

Reimplemented in oETCS::DF::PS::SIM::CEmergencyBrake.

Definition at line 118 of file AdaptorStubsMOC.cpp.

void oETCS::DF::PS::CEmergencyBrake::SetActivation ( bool  bActivated)
virtualslot

sets the activation state

This method should be reimplemented or extened for a concrete HW device.

Parameters
[in]bActivatedthe new activation flag

Reimplemented in oETCS::DF::PS::SIM::CEmergencyBrake.

Definition at line 136 of file AdaptorStubsMOC.cpp.


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