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::CServiceBrake Class Reference

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

#include <AdaptorStubsMOC.h>

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

Public Slots

virtual double GetIntensity ()
 gets the activation intensity
virtual void SetIntensity (const double &dIntensity)
 sets the activation intensity

Signals

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

Public Member Functions

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

Detailed Description

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

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

Definition at line 240 of file AdaptorStubsMOC.h.

Constructor & Destructor Documentation

oETCS::DF::PS::CServiceBrake::CServiceBrake ( ::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 147 of file AdaptorStubsMOC.cpp.

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

destructor

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

Definition at line 159 of file AdaptorStubsMOC.cpp.

Member Function Documentation

void oETCS::DF::CServiceBrake::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 958 of file PlatformSpecificClientsMOC.cpp.

double oETCS::DF::PS::CServiceBrake::GetIntensity ( )
virtualslot

gets the activation intensity

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

Returns
activation intensity of the service brake in [%]

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

Definition at line 170 of file AdaptorStubsMOC.cpp.

void oETCS::DF::PS::CServiceBrake::SetIntensity ( const double &  dIntensity)
virtualslot

sets the activation intensity

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

Parameters
[in]bIntensitythe new activation intensity in [%]

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

Definition at line 188 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/.