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

CFpsConvert Klassenreferenz

converts between working units Mehr...

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 ()
virtual ~CFpsConvert ()
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

 CFpsConvert ()
virtual ~CFpsConvert ()
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)

Ausführliche Beschreibung

Version:
1.0
Autor:
Ingo Fröhlich

Dokumentation der Aufzählungstypen

enum CFpsConvert::FPS_MEASURE_MODE
 

Aufzählungswerte:
MM 
VOLT  use mV

enum CFpsConvert::FPS_MEASURE_MODE
 

Aufzählungswerte:
MM 
VOLT  use mV

Beschreibung der Konstruktoren und Destruktoren

CFpsConvert::CFpsConvert (   ) 
 

virtual CFpsConvert::~CFpsConvert (   )  [virtual]
 

CFpsConvert::CFpsConvert (   ) 
 

virtual CFpsConvert::~CFpsConvert (   )  [virtual]
 

Dokumentation der Elementfunktionen

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

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

Parameter:
mV 
mm 
Rückgabe:
true ok

false not enough space to store the new data point

void CFpsConvert::clear (  void   ) 
 

void CFpsConvert::clear (  void   ) 
 

Parameter:
--- 
Rückgabe:
---

void CFpsConvert::ClearModifiedFlag (  const unsigned int  uiCurPoint  ) 
 

Parameter:
index of the data point
Rückgabe:
---

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

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

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
 

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
) 
 

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

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
 

Parameter:
mV 
returned native value
Rückgabe:
---

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

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
 

Parameter:
native value
returned mV
Rückgabe:
---

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

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

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
) 
 

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

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   ) 
 

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
 

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
 

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
 

float CFpsConvert::GetMaxMm (  void   )  const
 

Parameter:
--- 
Rückgabe:
the max. mm

FPS_MEASURE_MODE CFpsConvert::GetMeasureMode (  void   )  const
 

FPS_MEASURE_MODE CFpsConvert::GetMeasureMode (  void   )  const
 

Parameter:
--- 
Rückgabe:
the current working unit

float CFpsConvert::GetMinMm (  void   )  const
 

float CFpsConvert::GetMinMm (  void   )  const
 

Parameter:
--- 
Rückgabe:
the min. mm

unsigned int CFpsConvert::GetNumStuetzStellen (  void   )  const
 

unsigned int CFpsConvert::GetNumStuetzstellen (  void   )  const
 

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

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

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

Parameter:
index 
returned mV
returned mm
Rückgabe:
true everything is ok

false else

int CFpsConvert::GetVersion (  void   )  const
 

int CFpsConvert::GetVersion (  void   )  const
 

Parameter:
--- 
Rückgabe:
version

void CFpsConvert::IncCurStuetzstelle (  void   ) 
 

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
) 
 

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  ) 
 

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  ) 
 

void CFpsConvert::SetMeasureMode (  const FPS_MEASURE_MODE  NewMode  ) 
 

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

void CFpsConvert::SetNumStuetzstellen (  unsigned int  uiNewNumStuetzstellen  ) 
 

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
) 
 

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

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

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

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:
Erzeugt am Tue Mar 11 14:25:20 2008 für SchunkFPSAPI von doxygen 1.3.7