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

super class for odometer implementations More...

#include <PlatformSpecificClientsMOC.h>

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

Public Slots

void Error (const QString &ErrorMessage)
 informs the stub about an error ocurred in the PS part

Public Member Functions

virtual void Calculate () throw (::oETCS::DF::Error::CException)
 method for computing all outputs
 COdometer (oETCS::DF::CEVCStateMachine *const pStateMachine, const bool &bUsePS=false) throw ()
 default/general constructor
virtual ~COdometer () throw ()
 destructor

Public Attributes

::std::vector
< oETCS::DF::DOUBLE_OUTPUT_T
m_AbsolutePosition
 pointers to storage of the absolute position
const bool m_bUsePlatformSpecific
 flag for the usage of a platform specific implmentation via D-Bus
oETCS::DF::CEVCStateMachine *const m_pStateMachine
 pointer to the all contenting EVC state machine
::std::vector
< oETCS::DF::DOUBLE_OUTPUT_T
m_Velocity
 pointers to storage of the velocity

Private Attributes

::std::vector< ::std::string > m_ErrorStack
 stack with error messages from the platform specific adaptor implementation
::std::recursive_mutex m_Mutex
 muteable exclusion object
oETCS::DF::IOdometer * m_pProxy
 pointer to the proxy object

Detailed Description

super class for odometer implementations

Definition at line 386 of file PlatformSpecificClientsMOC.h.

Constructor & Destructor Documentation

oETCS::DF::COdometer::COdometer ( oETCS::DF::CEVCStateMachine *const  pStateMachine,
const bool &  bUsePS = false 
) throw ()

default/general constructor

Parameters
[in]pStateMachinepointer to the parent EVC state machine object
[in]bUsePSoptional flag for the usage of the platform specifc implementation via D-Bus

Definition at line 623 of file PlatformSpecificClientsMOC.cpp.

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

destructor

Definition at line 678 of file PlatformSpecificClientsMOC.cpp.

References m_bUsePlatformSpecific, and m_pProxy.

Member Function Documentation

void oETCS::DF::COdometer::Calculate ( ) throw (::oETCS::DF::Error::CException)
virtual

method for computing all outputs

Remarks
must be implemented for all odometer implementations

Implements oETCS::DF::CFunctionBlock.

Definition at line 695 of file PlatformSpecificClientsMOC.cpp.

References m_AbsolutePosition, m_bUsePlatformSpecific, m_ErrorStack, m_Mutex, m_pProxy, and m_Velocity.

void oETCS::DF::COdometer::Error ( const QString &  ErrorMessage)
slot

informs the stub about an error ocurred in the PS part

Remarks
this method should be called by a platform specific implementation
Parameters
[in]ErrorMessagetextual description of the error

Member Data Documentation

::std::vector< oETCS::DF::DOUBLE_OUTPUT_T > oETCS::DF::COdometer::m_AbsolutePosition

pointers to storage of the absolute position

Definition at line 434 of file PlatformSpecificClientsMOC.h.

Referenced by Calculate().

const bool oETCS::DF::COdometer::m_bUsePlatformSpecific

flag for the usage of a platform specific implmentation via D-Bus

Definition at line 448 of file PlatformSpecificClientsMOC.h.

Referenced by Calculate(), and ~COdometer().

::std::vector< ::std::string > oETCS::DF::COdometer::m_ErrorStack
private

stack with error messages from the platform specific adaptor implementation

Definition at line 457 of file PlatformSpecificClientsMOC.h.

Referenced by Calculate().

::std::recursive_mutex oETCS::DF::COdometer::m_Mutex
private

muteable exclusion object

Definition at line 471 of file PlatformSpecificClientsMOC.h.

Referenced by Calculate().

oETCS::DF::IOdometer* oETCS::DF::COdometer::m_pProxy
private

pointer to the proxy object

Definition at line 464 of file PlatformSpecificClientsMOC.h.

Referenced by Calculate(), and ~COdometer().

oETCS::DF::CEVCStateMachine* const oETCS::DF::CFunctionBlock::m_pStateMachine
inherited

pointer to the all contenting EVC state machine

Definition at line 894 of file EVCStateMachine.h.

Referenced by oETCS::DF::CCondition::Calculate(), and oETCS::DF::CDMIOutput::Calculate().

::std::vector< oETCS::DF::DOUBLE_OUTPUT_T > oETCS::DF::COdometer::m_Velocity

pointers to storage of the velocity

Definition at line 441 of file PlatformSpecificClientsMOC.h.

Referenced by Calculate().


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