TCmd Klassenreferenz

Realisiert ein Kommando. Mehr...

#include <TCmd.h>

Klassendiagramm für TCmd:

[Legende]Aufstellung aller Elemente

Öffentliche Methoden
	TCmd (TCmdTag)
	Konstruktor.
virtual	~TCmd ()
	Destruktor.
virtual bool	GetShowData (LPSTR s)
	Liefert Ausgabedaten.
virtual void	GetName (LPSTR s)
	Liefert den Namen des Kommandos.
virtual ECmdCode	FirstStep (void)
	Wird bei der Kommandoverarbeitung zu Beginn ausgeführt.
virtual ECmdCode	ControlStep (void)
	Eigentliche Kommandoverarbeitung.
virtual ECmdCode	ReadyStep (void)
	Wird am Ende der Kommandoverarbeitung ausgeführt.
virtual ECmdCode	Ready (void)
	Wird nach der Kommandoverarbeitung.
ECmdCode	DoAction (void)
	Wählt die nächste Aktion aus, die augeführt werden soll (in Abhängigkeit des Zustandsmerkers eStep).
virtual ECmdCode	WakeUp (void)
ECmdId	GetId (void)
	Liefert den Identifier des Kommandos.
BOOL	IsPositionValid (void)
	Dient zum überprüfen, ob sich der Motor in einer gültigen Position befindet.
BOOL	IsReady (void)
	Gibt an, ob ein Kommando abgeschlossen wurde.
BOOL	StartMove (const int mid, double dist)
	Bewegt einen Antrieb.
Geschützte Attribute
ECmdCode	eStep
	Zustandsmerker.
BOOL	bNoMeasure
	Gibt an, ob Messungen durchgeführt werden sollen.
BOOL *	bMoveOk
	Gibt an, ob eine Motorbewegung erfolgreich war.
int	nFailureId
	Spezifiziert die Art eines aufgetretenen Fehlers.
BOOL	bRestart
	Gibt an, ob ein Kommando erneut gestartet wurde oder gestartet werden kann?

---

Ausführliche Beschreibung

Realisiert ein Kommando.

Autor:

David Damm

Datum:

04.07.2004

Version:

0.1 Doxygen-Kommentare hinzugefügt.

---

Beschreibung der Konstruktoren und Destruktoren

TCmd::TCmd (  TCmdTag   )

Konstruktor. Realisierung eines Kommandos. Parameter: ct  Das eingelesene Kommando mit Parametern. Hier ist der Graph aller Aufrufe für diese Funktion:

TCmd::~TCmd (   )  [virtual]

Destruktor. Hier ist der Graph aller Aufrufe für diese Funktion:

---

Dokumentation der Elementfunktionen

ECmdCode TCmd::ControlStep (  void   )  [virtual]

Eigentliche Kommandoverarbeitung. Rückgabe: CmdCode, der angibt, welcher Schritt als nächstes ausgeführt wird. Erneute Implementation in TAreaScanCmd, TControlFlankCmd, TGotoIntensityCmd, TGotoPeakCmd und TScanCmd.

ECmdCode TCmd::DoAction (  void   )

Wählt die nächste Aktion aus, die augeführt werden soll (in Abhängigkeit des Zustandsmerkers eStep). Dabei wird zwischen den vier Schritten der Kommandoverarbeitung FirstStep() ControlStep() ReadyStep() Ready() unterschieden. Rückgabe: CmdCode, der angibt, welcher Schritt als nächstes ausgeführt wird. Hier ist der Graph aller Aufrufe für diese Funktion:

ECmdCode TCmd::FirstStep (  void   )  [virtual]

Wird bei der Kommandoverarbeitung zu Beginn ausgeführt. Rückgabe: CmdCode, der angibt, welcher Schritt als nächstes ausgeführt wird. Erneute Implementation in TAreaScanCmd, TControlFlankCmd, TGotoIntensityCmd, TGotoPeakCmd und TScanCmd.

ECmdId TCmd::GetId (  void   )

Liefert den Identifier des Kommandos. Rückgabe: Die ID des Kommandos.

void TCmd::GetName (  LPSTR  s  )  [virtual]

Liefert den Namen des Kommandos. Parameter: [out]  s  String, in dem der Name zurückgegeben wird. Erneute Implementation in TAreaScanCmd, TCalculateCmd, TChooseAxisCmd, TChooseDetectorCmd, TControlFlankCmd, TGotoIntensityCmd, TGotoPeakCmd, TLoadPointCmd, TMoveToPointCmd, TSaveDataCmd, TScanCmd, TSetFileNameCmd, TSetupScanCmd, TSetWidthCmd und TShowValueCmd.

bool TCmd::GetShowData (  LPSTR  s  )  [virtual]

Liefert Ausgabedaten. Dem String s wird nur ein Wert zugewiesen, falls das Kommando abgeschlossen wurde. Parameter: [out]  s  String, in dem die Daten zurückgegeben werden. Rückgabe: Gibt immer true zurück. Erneute Implementation in TAreaScanCmd, TCalculateCmd, TChooseAxisCmd, TChooseDetectorCmd, TControlFlankCmd, TGotoIntensityCmd, TGotoPeakCmd, TLoadPointCmd, TMoveToPointCmd, TSaveDataCmd, TScanCmd, TSetFileNameCmd, TSetupScanCmd, TSetWidthCmd und TShowValueCmd. Hier ist der Graph aller Aufrufe für diese Funktion:

BOOL TCmd::IsPositionValid (  void   )

Dient zum überprüfen, ob sich der Motor in einer gültigen Position befindet. Rückgabe: true, falls die Position des Motors gültig ist.

BOOL TCmd::IsReady (  void   )

Gibt an, ob ein Kommando abgeschlossen wurde. Rückgabe: true, falls das Kommando beendet wurde.

ECmdCode TCmd::Ready (  void   )  [virtual]

Wird nach der Kommandoverarbeitung. Rückgabe: CmdCode, der angibt, welcher Schritt als nächstes ausgeführt wird.

ECmdCode TCmd::ReadyStep (  void   )  [virtual]

Wird am Ende der Kommandoverarbeitung ausgeführt. Rückgabe: CmdCode, der angibt, welcher Schritt als nächstes ausgeführt wird. Erneute Implementation in TAreaScanCmd, TControlFlankCmd, TGotoIntensityCmd, TGotoPeakCmd und TScanCmd.

BOOL TCmd::StartMove (  const int  mid, double  dist )

Bewegt einen Antrieb. Parameter: [in]  mid  Die ID des Motors, der bewegt werden soll. [in]  dist  Die absolute Position, die angefahren werden soll. Rückgabe: true, falls die Bewegung ausgeführt werden konnte. Hier ist der Graph aller Aufrufe für diese Funktion:

ECmdCode TCmd::WakeUp (  void   )  [virtual]

Hier ist der Graph aller Aufrufe für diese Funktion:

---

Dokumentation der Datenelemente

BOOL* TCmd::bMoveOk [protected]

Gibt an, ob eine Motorbewegung erfolgreich war.

BOOL TCmd::bNoMeasure [protected]

Gibt an, ob Messungen durchgeführt werden sollen. Ist bNoMeasure auf true gesetzt, so werden keine Messungen durchgeführt. Ist bNoMeasure = false, so erfolgt die Messung mit dem aktuell ausgewählten Detektor.

BOOL TCmd::bRestart [protected]

Gibt an, ob ein Kommando erneut gestartet wurde oder gestartet werden kann? Fehler: FIX Fehler 72 Wird in dieser Klasse nicht verwendet, aber vielleicht in abgeleiteten Klassen?

ECmdCode TCmd::eStep [protected]

Zustandsmerker. Die Variable eStep dient zum Merken des aktuellen Zustandes in der Kommandoverarbeitung und wird bei komplexen Kommandoabläufen benötigt. eStep kann unter anderem folgende Zustände annehmen: CReady CRecall CMeasure CStop

int TCmd::nFailureId [protected]

Spezifiziert die Art eines aufgetretenen Fehlers.

---

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

• TCmd.h
• TCmd.cpp

---