Hauptseite | Klassenhierarchie | Alphabetische Liste | Auflistung der Klassen | Auflistung der Dateien | Klassen-Elemente

# CFpsConvert Klassenreferenz

converts between working units Mehr...

`#include <convert.hpp>`

Aufstellung aller Elemente

## Öffentliche Typen
enum | FPS_MEASURE_MODE { MM, VOLT }
| currently used measure mode Mehr...
enum | FPS_MEASURE_MODE { MM, VOLT }
## Öffentliche Methoden
| CFpsConvert ()
| convert
int | GetVersion (void) const
| delivers the version of this class
void | SetMeasureMode (const FPS_MEASURE_MODE NewMode)
| sets the current working unit
FPS_MEASURE_MODE | GetMeasureMode (void) const
| delivers the current working unit ( mm or mV )
void | clear (void)
| clears the stored stuetzstellen ( data points )
float | GetMaxMm (void) const
| delivers the maximum ( in mm ) of the stored data points
float | GetMinMm (void) const
| delivers the minimum ( in mm ) of the stored data points
unsigned int | GetNumStuetzstellen (void) const
| delivers the number of stored data points
void | SetNumStuetzstellen (unsigned int uiNewNumStuetzstellen)
| sets the number of stored data points
bool | AddStuetzstelle (const float fX, const float fY)
| add a new data point
void | SetStuetzstelle (const unsigned int uiIndex, const float fX, const float fY)
| sets a specific data point
bool | GetStuetzstelle (const unsigned int uiIndex, float &fX, float &fY) const
| delivers the data point conresponding to the overgiven index
void | SetCurStuetzstelle (const unsigned int uiCurStuetzstelle)
| sets the currently used data point index
unsigned int | GetCurStuetzstelle (void) const
| delivers the currently used data point index
void | SetCurStuetzstelle (const float fX, const float fY)
| sets the current data point
void | GetCurStuetzstelle (float &fX, float &fY) const
| delivers the current data point
void | IncCurStuetzstelle (void)
| incremens the current data point index
void | DecCurStuetzstelle (void)
| decremens the current data point
bool | StuetzstelleWasModified (const unsigned int uiIndex) const
| delivers the information if the corresponding data point was modified since the start of the program
void | ClearModifiedFlag (const unsigned int uiCurPoint)
| marks the data point as unmodified
bool | ConvertMvToMm (const float fValueIn, float &fValueOut) const
| convert between mV/mm
bool | ConvertMmToMv (const float fValueIn, float &fValueOut) const
| convert between mm/mV
void | ConvertMvToNative (const float fValueIn, int &iValueOut) const
| convert mV to native( 16 bit value )
void | ConvertMmToNative (const float fValueIn, int &iValueOut) const
| convert mm to native( 16 bit value )
bool | ConvertSpecToNative (const float fValueIn, int &iValueOut) const
| convert current working unit to native( 16 bit value )
void | ConvertNativeToMv (const unsigned int iValueIn, float &fValueOut) const
| convert current native ( 16 bit value ) to mV
void | ConvertNativeToMm (const unsigned int iValueIn, float &fValueOut) const
| convert current native ( 16 bit value ) to mm
bool | ConvertNativeToSpec (const unsigned int iValueIn, float &fValueOut) const
| convert current native ( 16 bit value ) to current working unit
int | GetVersion (void) const
void | SetMeasureMode (const FPS_MEASURE_MODE NewMode)
FPS_MEASURE_MODE | GetMeasureMode (void) const
void | clear (void)
float | GetMaxMm (void) const
float | GetMinMm (void) const
bool | ConvertMvToMm (float fValueIn, float &fValueOut)
bool | ConvertMmToMv (float fValueIn, float &fValueOut)
unsigned int | GetNumStuetzStellen (void) const
bool | AddStuetzStelle (const float fX, const float fY)
bool | SetStuetzStelle (const unsigned int uiIndex, const float fX, const float fY)
bool | GetStuetzStelle (const unsigned int uiIndex, float &fX, float &fY) const
bool | ConvertNativeToSpec (unsigned int iValueIn, float &fValueOut)
bool | ConvertSpecToNative (float fValueIn, int &iValueOut)
## Private Attribute
FPS_MEASURE_MODE | m_CurMeasureMode
| current working unit
int | m_iStuetzArrayVersion
| version of this class
unsigned int | m_CurNumStuetzstellen
| current number of stored data points
unsigned int | m_uiCurStuetzstelle
| current data point index
float | m_StuetzX [MAX_STUETZSTELLEN]
| mV data point values
float | m_StuetzY [MAX_STUETZSTELLEN]
| mm data point values
bool | m_Modified [MAX_STUETZSTELLEN]
| modified flags
unsigned int | m_CurNumStuetzStellen

## Ausführliche Beschreibung

converts between working units

Version:
  1.0

Autor:
  Ingo Fröhlich

## Dokumentation der Aufzählungstypen

enum CFpsConvert::FPS_MEASURE_MODE

  | Aufzählungswerte:
  VOLT | use mV

enum CFpsConvert::FPS_MEASURE_MODE

  | currently used measure mode Aufzählungswerte:
  VOLT | use mV

## Beschreibung der Konstruktoren und Destruktoren

CFpsConvert::CFpsConvert | ( |  | ) |

| convert class converts between mm and volt using a stuetzstellen array Autor: Ingo Fröhlich date 23.07.01 Copyright Analytica GmbH

## Dokumentation der Elementfunktionen

bool CFpsConvert::AddStuetzStelle | ( | const float | fX,
|  | const float | fY
| ) |

  | Parameter:
  | x | values : means valtage, y values : means mm
Rückgabe: true : operation was successfull, false : not enought space for more Stuetzstellen

bool CFpsConvert::AddStuetzstelle | ( | const float | fX,
|  | const float | fY
| ) |

  | add a new data point Parameter:
  | mV |
  | mm |
Rückgabe: true ok false not enough space to store the new data point

void CFpsConvert::clear | ( | void |  | ) |

  | clears the stored stuetzstellen ( data points ) Parameter:
  | --- |
Rückgabe: ---

void CFpsConvert::ClearModifiedFlag | ( | const unsigned int | uiCurPoint | ) |

  | marks the data point as unmodified Parameter:
  | index | of the data point
Rückgabe: ---

bool CFpsConvert::ConvertMmToMv | ( | float | fValueIn,
|  | float & | fValueOut
| ) |

  | Parameter:
  | values | which should be converted,
  | converted | value
Rückgabe: true : ok, false : something is gone wrong

bool CFpsConvert::ConvertMmToMv | ( | const float | fValueIn,
|  | float & | fValueOut
| ) | const

  | convert between mm/mV Parameter:
  | mm |
  | returned | mV
Rückgabe: true ok false error ( e.g. no data points stored )

void CFpsConvert::ConvertMmToNative | ( | const float | fValueIn,
|  | int & | iValueOut
| ) | const

  | convert mm to native( 16 bit value ) Zu beachten: additional bounding data points are 10 mm, 0 mV and 0 mm, 5000 mV this ensures that a convertion is always possible Parameter:
  | mm |
  | returned | native value
Rückgabe: ---

bool CFpsConvert::ConvertMvToMm | ( | float | fValueIn,
|  | float & | fValueOut
| ) |

  | Parameter:
  | values | which should be converted,
  | converted | value
Rückgabe: true : ok, false : something is gone wrong

bool CFpsConvert::ConvertMvToMm | ( | const float | fValueIn,
|  | float & | fValueOut
| ) | const

  | convert between mV/mm Parameter:
  | mV |
  | returned | mm
Rückgabe: true ok false error ( e.g. no data points stored )

void CFpsConvert::ConvertMvToNative | ( | const float | fValueIn,
|  | int & | iValueOut
| ) | const

  | convert mV to native( 16 bit value ) Parameter:
  | mV |
  | returned | native value
Rückgabe: ---

void CFpsConvert::ConvertNativeToMm | ( | const unsigned int | iValueIn,
|  | float & | fValueOut
| ) | const

  | convert current native ( 16 bit value ) to mm Zu beachten: additional bounding data points are 10 mm, 0 mV and 0 mm, 5000 mV this ensures that a convertion is always possible Parameter:
  | native | value
  | returned | mm
Rückgabe: ---

void CFpsConvert::ConvertNativeToMv | ( | const unsigned int | iValueIn,
|  | float & | fValueOut
| ) | const

  | convert current native ( 16 bit value ) to mV Parameter:
  | native | value
  | returned | mV
Rückgabe: ---

bool CFpsConvert::ConvertNativeToSpec | ( | unsigned int | iValueIn,
|  | float & | fValueOut
| ) |

  | Parameter:
  | values | which should be converted,
  | converted | value
Rückgabe: true : ok, false : something is gone wrong

bool CFpsConvert::ConvertNativeToSpec | ( | const unsigned int | iValueIn,
|  | float & | fValueOut
| ) | const

  | convert current native ( 16 bit value ) to current working unit Zu beachten: additional bounding data points are 10 mm, 0 mV and 0 mm, 5000 mV this ensures that a convertion is always possible Parameter:
  | native | value
  | returned | current working unit
Rückgabe: true ok

bool CFpsConvert::ConvertSpecToNative | ( | float | fValueIn,
|  | int & | iValueOut
| ) |

  | Parameter:
  | values | which should be converted,
  | converted | value
Rückgabe: true : ok, false : something is gone wrong

bool CFpsConvert::ConvertSpecToNative | ( | const float | fValueIn,
|  | int & | iValueOut
| ) | const

  | convert current working unit to native( 16 bit value ) Zu beachten: additional bounding data points are 10 mm, 0 mV and 0 mm, 5000 mV this ensures that a convertion is always possible Parameter:
  | mm | or mV
  | returned | native value
Rückgabe: true ok

void CFpsConvert::DecCurStuetzstelle | ( | void |  | ) |

  | decremens the current data point Zu beachten: use the SetCur/ GetCur / IncCur / DecCur functions for easy traversion through the array of stored data points Parameter:
  | --- |
Rückgabe: ---

void CFpsConvert::GetCurStuetzstelle | ( | float & | fX,
|  | float & | fY
| ) | const

  | delivers the current data point Zu beachten: use the SetCur/ GetCur / IncCur / DecCur functions for easy traversion through the array of stored data points Parameter:
  | returned | mV
  | returned | mm
Rückgabe: ---

unsigned int CFpsConvert::GetCurStuetzstelle | ( | void |  | ) | const

  | delivers the currently used data point index Zu beachten: use the SetCur/ GetCur / IncCur / DecCur functions for easy traversion through the array of stored data points Parameter:
  | --- |
Rückgabe: currently used index

float CFpsConvert::GetMaxMm | ( | void |  | ) | const

  | delivers the maximum ( in mm ) of the stored data points Parameter:
  | --- |
Rückgabe: the max. mm

CFpsConvert::FPS_MEASURE_MODE CFpsConvert::GetMeasureMode | ( | void |  | ) | const

  | delivers the current working unit ( mm or mV ) Parameter:
  | --- |
Rückgabe: the current working unit

float CFpsConvert::GetMinMm | ( | void |  | ) | const

  | delivers the minimum ( in mm ) of the stored data points Parameter:
  | --- |
Rückgabe: the min. mm

unsigned int CFpsConvert::GetNumStuetzStellen | ( | void |  | ) | const

  | Parameter:
  | --- |
Rückgabe: the number of stored stuetzstellen

unsigned int CFpsConvert::GetNumStuetzstellen | ( | void |  | ) | const

  | delivers the number of stored data points Parameter:
  | --- |
Rückgabe: the number of stored data points

bool CFpsConvert::GetStuetzStelle | ( | const unsigned int | uiIndex,
|  | float & | fX,
|  | float & | fY
| ) | const

  | Parameter:
  | index | of the stuetzstelle, which should be delivered,
  | returnvalues | :: x values : means valtage, y values : means mm
Rückgabe: true : ok, false : wrong index

bool CFpsConvert::GetStuetzstelle | ( | const unsigned int | uiIndex,
|  | float & | fX,
|  | float & | fY
| ) | const

  | delivers the data point conresponding to the overgiven index Parameter:
  | index |
  | returned | mV
  | returned | mm
Rückgabe: true everything is ok false else

int CFpsConvert::GetVersion | ( | void |  | ) | const

  | delivers the version of this class Parameter:
  | --- |
Rückgabe: version

void CFpsConvert::IncCurStuetzstelle | ( | void |  | ) |

  | incremens the current data point index Zu beachten: use the SetCur/ GetCur / IncCur / DecCur functions for easy traversion through the array of stored data points Parameter:
  | --- |
Rückgabe: ---

void CFpsConvert::SetCurStuetzstelle | ( | const float | fX,
|  | const float | fY
| ) |

  | sets the current data point Zu beachten: use the SetCur/ GetCur / IncCur / DecCur functions for easy traversion through the array of stored data points Parameter:
  | mV |
  | mm |
Rückgabe: ---

void CFpsConvert::SetCurStuetzstelle | ( | const unsigned int | uiCurStuetzstelle | ) |

  | sets the currently used data point index Zu beachten: use the SetCur/ GetCur / IncCur / DecCur functions for easy traversion through the array of stored data points addition note if the new index < 1 the index will be set to 1 new index > max. max. Parameter:
  | new | current index
Rückgabe: ---

void CFpsConvert::SetMeasureMode | ( | const FPS_MEASURE_MODE | NewMode | ) |

  | sets the current working unit Parameter:
  | the | new working unit ( mm or mV )
Rückgabe: ---

void CFpsConvert::SetNumStuetzstellen | ( | unsigned int | uiNewNumStuetzstellen | ) |

  | sets the number of stored data points Zu beachten: the default values for data points are 0 mm / 0 mV Parameter:
  | new | number of stored data points
Rückgabe: ---

bool CFpsConvert::SetStuetzStelle | ( | const unsigned int | uiIndex,
|  | const float | fX,
|  | const float | fY
| ) |

  | Parameter:
  | index | of the stuetzstelle, which should be changed,
  | x | values : means valtage, y values : means mm
Rückgabe: true : ok, false : wrong index

void CFpsConvert::SetStuetzstelle | ( | const unsigned int | uiIndex,
|  | const float | fX,
|  | const float | fY
| ) |

  | sets a specific data point Parameter:
  | index | of the new data point ( array index )
  | mV |
  | mm |
Rückgabe: ---

bool CFpsConvert::StuetzstelleWasModified | ( | const unsigned int | uiIndex | ) | const

  | delivers the information if the corresponding data point was modified since the start of the program Parameter:
  | index | of the data point
Rückgabe: true data point was modified false else

Die Dokumentation für diese Klasse wurde erzeugt aufgrund der Dateien:

- convert.hpp
- fps_convert.hpp
- convert.cpp
- fps_convert.cpp