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

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

#include <AdaptorStubsMOC.h>

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

Public Slots

virtual double GetAbsolutePosition ()
 gets the current absolute position
virtual double GetVelocity ()
 gets the current velocity

Signals

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

Public Member Functions

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

Detailed Description

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

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

Definition at line 307 of file AdaptorStubsMOC.h.

Constructor & Destructor Documentation

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

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

destructor

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

Definition at line 211 of file AdaptorStubsMOC.cpp.

Member Function Documentation

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

double oETCS::DF::PS::COdometer::GetAbsolutePosition ( )
virtualslot

gets the current absolute position

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

Returns
current absolute position in [m]

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

Definition at line 222 of file AdaptorStubsMOC.cpp.

double oETCS::DF::PS::COdometer::GetVelocity ( )
virtualslot

gets the current velocity

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

Returns
current velocity in [km/h]

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

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