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

class for inputs from the driver via the DMI More...

#include <FunctionBlocks.h>

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

Public Member Functions

virtual void Calculate () throw (::oETCS::DF::Error::CException)
 pure virtual method for computing all outputs
 CDMIInput (oETCS::DF::CEVCStateMachine *const pStateMachine, const oETCS::DF::DATA_T &eType, const ::std::string &Label="", const bool &bInitialVisible=true) throw ()
 general constructor
virtual ~CDMIInput () throw ()

Public Attributes

::std::vector< bool > m_AllowedBoolInputs
 set of allowed boolean inputs by DMI
::std::vector< double > m_AllowedDoubleInputs
 set of allowed double inputs by DMI
::std::vector< int > m_AllowedIntInputs
 set of allowed integer inputs by DMI
::std::vector< ::std::string > m_AllowedStringInputs
 set of allowed string inputs by DMI
oETCS::DF::BOOL_INPUT_T m_bBool
 storage of an entered boolean message
::std::vector
< oETCS::DF::BOOL_OUTPUT_T > 		m_BoolMessage
 pointers to boolean results of input
oETCS::DF::BOOL_INPUT_T m_bVisible
 storage of the visible flag input
oETCS::DF::DOUBLE_INPUT_T m_dDouble
 storage of an entered double message
::std::vector
< oETCS::DF::DOUBLE_OUTPUT_T > 		m_DoubleMessage
 pointers to double results of input
::std::vector
< oETCS::DF::BOOL_OUTPUT_T > 		m_EnteredData
 vevtor with pointers to boolean inputs for entered data
const oETCS::DF::DATA_T m_eType
 data type of input
oETCS::DF::INT_INPUT_T m_iInt
 storage of an entered integer message
::std::vector
< oETCS::DF::INT_OUTPUT_T > 		m_IntMessage
 pointers to integer results of input
const ::std::string m_Label
 optional label
oETCS::DF::CEVCStateMachine *const m_pStateMachine
 pointer to the all contenting EVC state machine
oETCS::DF::STRING_INPUT_T m_String
 storage of a predefined string message
::std::vector
< oETCS::DF::STRING_OUTPUT_T > 		m_StringMessage
 pointers to string results of input

Detailed Description

class for inputs from the driver via the DMI

Definition at line 1634 of file FunctionBlocks.h.

Constructor & Destructor Documentation

oETCS::DF::CDMIInput::CDMIInput ( oETCS::DF::CEVCStateMachine *const  pStateMachine,
const oETCS::DF::DATA_T &  eType,
const ::std::string &  Label = "",
const bool &  bInitialVisible = true 
) throw ()
explicit

general constructor

Parameters
[in]pStateMachinepointer to the parent EVC state machine object
[in]eTypedata type of the input
[in]pParentoptional pointer to parent widget
[in]Labeloptional label string
[in]bInitialVisibleoptional flag for initial visibility

Definition at line 1619 of file FunctionBlocks.cpp.

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

Definition at line 1638 of file FunctionBlocks.cpp.

Member Function Documentation

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

pure virtual method for computing all outputs

Remarks
must me implemented by any inheriting class

Implements oETCS::DF::CFunctionBlock.

Definition at line 1649 of file FunctionBlocks.cpp.

References oETCS::DF::BOOL, oETCS::DF::DOUBLE, oETCS::DF::DOUBLE_ARRAY, oETCS::DF::INT, oETCS::DF::CFunctionBlock::CInput< INPUT_TYPE_T >::IsModified(), m_bBool, m_BoolMessage, m_dDouble, m_DoubleMessage, m_EnteredData, m_eType, m_iInt, m_IntMessage, m_String, m_StringMessage, and oETCS::DF::STRING.

Here is the call graph for this function:

Member Data Documentation

::std::vector< bool > oETCS::DF::CDMIInput::m_AllowedBoolInputs

set of allowed boolean inputs by DMI

Definition at line 1708 of file FunctionBlocks.h.

Referenced by oETCS::DF::CDMIQWidget::DataEntered().

::std::vector< double > oETCS::DF::CDMIInput::m_AllowedDoubleInputs

set of allowed double inputs by DMI

Definition at line 1715 of file FunctionBlocks.h.

Referenced by oETCS::DF::CDMIQWidget::DataEntered().

::std::vector< int > oETCS::DF::CDMIInput::m_AllowedIntInputs

set of allowed integer inputs by DMI

Definition at line 1722 of file FunctionBlocks.h.

Referenced by oETCS::DF::CDMIQWidget::DataEntered().

::std::vector< ::std::string > oETCS::DF::CDMIInput::m_AllowedStringInputs

set of allowed string inputs by DMI

Definition at line 1729 of file FunctionBlocks.h.

Referenced by oETCS::DF::CDMIQWidget::DataEntered().

oETCS::DF::BOOL_INPUT_T oETCS::DF::CDMIInput::m_bBool

storage of an entered boolean message

Definition at line 1666 of file FunctionBlocks.h.

Referenced by Calculate().

::std::vector< oETCS::DF::BOOL_OUTPUT_T > oETCS::DF::CDMIInput::m_BoolMessage

pointers to boolean results of input

Definition at line 1736 of file FunctionBlocks.h.

Referenced by Calculate().

oETCS::DF::BOOL_INPUT_T oETCS::DF::CDMIInput::m_bVisible

storage of the visible flag input

Definition at line 1694 of file FunctionBlocks.h.

oETCS::DF::DOUBLE_INPUT_T oETCS::DF::CDMIInput::m_dDouble

storage of an entered double message

Definition at line 1673 of file FunctionBlocks.h.

Referenced by Calculate().

::std::vector< oETCS::DF::DOUBLE_OUTPUT_T > oETCS::DF::CDMIInput::m_DoubleMessage

pointers to double results of input

Definition at line 1743 of file FunctionBlocks.h.

Referenced by Calculate().

::std::vector< oETCS::DF::BOOL_OUTPUT_T > oETCS::DF::CDMIInput::m_EnteredData

vevtor with pointers to boolean inputs for entered data

Definition at line 1764 of file FunctionBlocks.h.

Referenced by Calculate().

const oETCS::DF::DATA_T oETCS::DF::CDMIInput::m_eType

data type of input

Definition at line 1771 of file FunctionBlocks.h.

Referenced by Calculate().

oETCS::DF::INT_INPUT_T oETCS::DF::CDMIInput::m_iInt

storage of an entered integer message

Definition at line 1680 of file FunctionBlocks.h.

Referenced by Calculate().

::std::vector< oETCS::DF::INT_OUTPUT_T > oETCS::DF::CDMIInput::m_IntMessage

pointers to integer results of input

Definition at line 1750 of file FunctionBlocks.h.

Referenced by Calculate().

const ::std::string oETCS::DF::CDMIInput::m_Label

optional label

Definition at line 1701 of file FunctionBlocks.h.

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().

oETCS::DF::STRING_INPUT_T oETCS::DF::CDMIInput::m_String

storage of a predefined string message

Definition at line 1687 of file FunctionBlocks.h.

Referenced by Calculate().

::std::vector< oETCS::DF::STRING_OUTPUT_T > oETCS::DF::CDMIInput::m_StringMessage

pointers to string results of input

Definition at line 1757 of file FunctionBlocks.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/.