TSteering Klassenreferenz

Dient zur Steuerung der Makroverarbeitung. Mehr...

#include <WORKFLOW.H>

Zusammengehörigkeiten von TSteering:

[Legende]Aufstellung aller Elemente


Öffentliche Methoden
	TSteering (void)
	Konstruktor.
virtual	~TSteering (void)
	Destruktor.
BOOL	Initialize (const HWND hwnd, const int mid, TDetector *d)
	Lädt Makros aus der Datei 'STANDARD.MAK'.
BOOL	LoadMacroByUser (void)
	Lädt Makros aus der Datei 'SCAN.MAK'.
BOOL	StartUp (const HWND hwnd, const int mid, TDetector *d)
	Setzt das Fenster, das für die Aktualisierung des Detektors zuständig ist (cm_CounterSet).
void	Visualising (BOOL a, BOOL b)
	Regelt, wie Fortschrittsanzeigen (während der Kommando-/Makroverarbeitung) auszugeben sind.
BOOL	StartMacroExecution (TMacroTag *macro, HWND hwnd)
	Startet die Verarbeitung des angegebenen Makros.
int	StartCmdExecution (ECmdId id, int p1, int p2, LPSTR p3, HWND)
	Erzeugt und startet ein neues Kommando.
BOOL	ToggleInterrupt (void)
	Pausiert die Makroverarbeitung bzw.
BOOL	Reset (BOOL=TRUE)
	Stoppt die Makroverarbeitung endgültig.
BOOL	DetectorRequest (void)
	Vom Fenster aufzurufen, das cm_CounterSet empfangen hat.
void	WakeUp (void)
	Vom Fenster aufzurufen, das wm_WakeUpSteering empfangen hat.
TMacroTag *	GetMacroById (EMacroId id)
	Wählt ein Makro per ID aus.
TMacroTag *	GetMacroByNumber (int)
	Wählt ein Makro per Nummer aus.
TMacroTag *	GetMacroByName (LPSTR s)
	Wählt ein Makro per Name aus.
BOOL	DeleteMacro (TMacroTag *macro)
	Löscht ein Makro.
int	GetMacroCount (void)
	Liefert die Anzahl der geladenen Makros.
BOOL	IsActive (void)
	Gibt Informationen über den derzeitigen Stand der Verarbeitung.
BOOL	IsReset (void)
	Gibt an, ob ein Kommando oder Makro abgebrochen wurde.
BOOL	GetProgress (int &ind, LPSTR s, int &n)
	NUR während der Makroverarbeitung werden Fortschrittsinfo's in den drei Parameterm zurückgegeben.
BOOL	IsPositionValid (void)
	Gibt Informationen über Positiionierung des Antriebes.
double	GetDistance (void)
	Position ermitteln.
void	SetStartPoint (double p)
	Kann zum Zwischenspeichern der aktuellen Antriebsposition verwendet werden.
double	GetStartPoint (void)
	Liefert den gespeicherten Wert zurück.
float	GetIntensity (void)
	Liefert die aktuelle Intensität des ausgewählten Detektors.
float	GetSigma (void)
	Faktor (fSigma) des ausgewählten Detektors.
void	SetNoiseLevel (float nl)
	Rauschlevel des ausgewählten Detektors setzen.
float	GetNoiseLevel (void)
	Rauschlevel des ausgewählten Detektors ermitteln.
void	SetNorm (float norm)
	Divisor, der zur Korrektur der aktuellen Intensität verwendet werden kann.
float	GetNorm (void)
	Liefert die Norm zur Korrektur der aktuellen Intensität.
void	SetResponse (BOOL sr)
	Sollen Meldungen ausgegeben werden (Statuszeile oder Listenfeld - abhängig von Visualising).
BOOL	IsResponding (void)
	Überprüfen, ob Meldungen ausgegeben werden.
void	SetHwb (double hwb)
	Setzt die Halbwertsbreite.
double	GetHwb (void)
	Halbwertsbreite auslesen.
Öffentliche Attribute
double	dGoalDistance
double	dPeakPoint
double	dStartPoint
float	fGoalIntensity
float	fPeakIntensity
float	fStartIntensity
double	dCalcResult
double	dCalcArg [nMaxArg]
TDetector *	Monitor

Ausführliche Beschreibung

Dient zur Steuerung der Makroverarbeitung.

Autor:: David Damm

Datum:: 05.07.2004

Version:: 0.1 Doxygen-Kommentare hinzugefügt.

Beschreibung der Konstruktoren und Destruktoren

TSteering::TSteering ( void )

Konstruktor.

TSteering::~TSteering ( void ) [virtual]

Destruktor.

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

Dokumentation der Elementfunktionen

BOOL TSteering::DeleteMacro ( TMacroTag * macro )

Löscht ein Makro.

Parameter:

macro Gibt das Makro an, das gelöscht werden soll.

Rückgabe:
false, falls das Makro nicht existiert. Wurde das Makro erfolgreich gelöscht, wird true zurückgegeben.

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

BOOL TSteering::DetectorRequest ( void )

Vom Fenster aufzurufen, das cm_CounterSet empfangen hat.

Rückgabe:
Gibt immer true zurück.

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

double TSteering::GetDistance ( void )

Position ermitteln.

Rückgabe:
Die aktuelle Absolutposition des ausgewählten Antriebs.

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

double TSteering::GetHwb ( void )

Halbwertsbreite auslesen.

Rückgabe:
Die Halbwertsbreite.

Siehe auch:
SetHwb

float TSteering::GetIntensity ( void )

Liefert die aktuelle Intensität des ausgewählten Detektors.

Rückgabe:
Die Intensität des Detektors.

TMacroTag * TSteering::GetMacroById ( EMacroId id )

Wählt ein Makro per ID aus.

Parameter:

id Der Identifier des Makros.

Rückgabe:
Das gesuchte Makro.

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

TMacroTag * TSteering::GetMacroByName ( LPSTR s )

Wählt ein Makro per Name aus.

Parameter:

s Gibt den Namen des Makros an.

Rückgabe:
Das gesuchte Makro.

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

TMacroTag * TSteering::GetMacroByNumber ( int )

Wählt ein Makro per Nummer aus.

Parameter:

num Gibt die Nummer des Makros an, an der es in der Liste aMacroList steht.

Rückgabe:
Das gesuchte Makro.

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

int TSteering::GetMacroCount ( void )

Liefert die Anzahl der geladenen Makros.

Rückgabe:
Anzahl der Makros.

float TSteering::GetNoiseLevel ( void )

Rauschlevel des ausgewählten Detektors ermitteln.

Rückgabe:
Der Rauschlevel.

Siehe auch:
SetNoiseLevel

float TSteering::GetNorm ( void )

Liefert die Norm zur Korrektur der aktuellen Intensität.

Rückgabe:
Mormierungsfaktor.

Siehe auch:
SetNorm

BOOL TSteering::GetProgress ( int & ind,

LPSTR s,

int & n

)

NUR während der Makroverarbeitung werden Fortschrittsinfo's in den drei Parameterm zurückgegeben.

Parameter:

[out] ind Index des aktuellen Kommandos im Intervall von [0...n].

[out] s Gibt Statusinformationen aus. Wenn keine verfügbar sind, dann Bezeichnung des aktuellen Kommandos.

[out] n Gibt die Anzahl der Kommandos während dieser Makro- oder Einzelkommandoverarbeitung an.

Rückgabe:
false, falls gerade keine Verarbeitung stattfindet, sonst true.

Warnung:
Sprungkommandos beeinflussen den Kontrollfluss! D.h. der Index des aktuelles Kommdandos kann (auch um mehr als 1) erhöht ODER erniedrigt werden! Fortschrittsanzeige demnach nicht möglich.

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

float TSteering::GetSigma ( void )

Faktor (fSigma) des ausgewählten Detektors.

Rückgabe:
Faktor fSigma.

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

double TSteering::GetStartPoint ( void )

Liefert den gespeicherten Wert zurück.

Rückgabe:
Die gespeicherte Position.

Siehe auch:
SetStartPoint

BOOL TSteering::Initialize ( const HWND hwnd,

const int mid,

TDetector * d

)

Lädt Makros aus der Datei 'STANDARD.MAK'.
Außerdem wird das Ausgabefenster ausgewählt, der entsprechende Motor aktiviert und der Detektor ausgewählt.
Parameter:

hwnd Das Ausgabefenster.

mid ID des Antriebes.

d Der Detektor.

Rückgabe:
true, falls alle fünf Makros aus der Datei 'STANDARD.MAK' erfolgreich geladen werden konnten. Die Standardmakros lauten:

InquireHwb
SearchReflection
SetupTopography
AzimutalJustify
Test.

Siehe auch:
StartUp

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

BOOL TSteering::IsActive ( void )

Gibt Informationen über den derzeitigen Stand der Verarbeitung.

Rückgabe:
true, gdw. Makro ODER Einzelkommando derzeit verarbeitet wird.

BOOL TSteering::IsPositionValid ( void )

Gibt Informationen über Positiionierung des Antriebes.

Rückgabe:
true, gdw. Positionierung des ausgewählten Antriebs war erfolgreich.

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

BOOL TSteering::IsReset ( void )

Gibt an, ob ein Kommando oder Makro abgebrochen wurde.

Rückgabe:
true, gdw. Makro- ODER Einzelkommandoverarbeitung abgebrochen wurde.

BOOL TSteering::IsResponding ( void )

Überprüfen, ob Meldungen ausgegeben werden.

Rückgabe:
true, falls Meldungen ausgegeben werden.

Siehe auch:
SetResponse

BOOL TSteering::LoadMacroByUser ( void )

Lädt Makros aus der Datei 'SCAN.MAK'.

Rückgabe:
true, falls alle Makros aus der Datei 'SCAN.MAK' erfolgreich geladen wurden. Zu diesen Makros zählen:

ScanJob
AreaScanJob.

BOOL TSteering::Reset ( BOOL = TRUE )

Stoppt die Makroverarbeitung endgültig.
Das Makro kann dann nicht mehr fortgesetzt, sondern nur von neuem gestartet werden.
Parameter:

a Falls true, so wird auf dem Host-Window eine Message ausgegeben.

Rückgabe:
Gibt immer true zurück.

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

void TSteering::SetHwb ( double hwb )

Setzt die Halbwertsbreite.

Parameter:

hwb Die neue Halbwertsbreite.

Warnung:
Wenn die Halbwertsbreite bislang nicht berechnet wurde (CalculateCmd-Kommando NOCH nicht ausgeführt ODER bislang kein Makro verarbeitet). ist HWB == 0.

Siehe auch:
GetHwb

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

void TSteering::SetNoiseLevel ( float nl )

Rauschlevel des ausgewählten Detektors setzen.

Parameter:

nl Der neue Rauschlevel.

Siehe auch:
GetNoiseLevel

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

void TSteering::SetNorm ( float norm )

Divisor, der zur Korrektur der aktuellen Intensität verwendet werden kann.

Parameter:

norm Normierungsfaktor für die Korrektur.

Siehe auch:
GetNorm

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

void TSteering::SetResponse ( BOOL sr )

Sollen Meldungen ausgegeben werden (Statuszeile oder Listenfeld - abhängig von Visualising).

Parameter:

sr Gibt Meldung aus, falls true.

Siehe auch:
IsResponding

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

void TSteering::SetStartPoint ( double p )

Kann zum Zwischenspeichern der aktuellen Antriebsposition verwendet werden.

Parameter:

p Die zu speichernde Position.

Siehe auch:
GetStartPoint

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

int TSteering::StartCmdExecution ( ECmdId id,

int p1,

int p2,

LPSTR p3,

HWND

)

Erzeugt und startet ein neues Kommando.

Parameter:

id ID des auszuführenden Kommandos.

p1 Der erste Programmparameter.

p2 Der zweite Programmparameter.

p3 Weitere Programmparameter in einem String.

hwnd Das Fenster ist für die Aktualisierung des Detektors zuständig (cm_CounterSet).

Rückgabe:
Gibt nur true/false zurück. Wenn das Kommando nicht existiert oder nicht ausgeführt werden kann, wird false zurückgegeben.

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

BOOL TSteering::StartMacroExecution ( TMacroTag * macro,

HWND hwnd

)

Startet die Verarbeitung des angegebenen Makros.
An das Fenster wird cm_SteeringReady geschickt, sobald die Makroverarbeitung beendet ist Tipp: stattdessen kann die POLLING-Methode IsActive() eingesetzt werden, um zu ermitteln, wann das Makro "fertig" ist.
Parameter:

macro Das auszuführende Makro.

hwnd Das Fenster (Host-Window).

Rückgabe:
false, falls das angegebene Makro nicht ausgeführt werden kann. Dann existiert das Makro nicht, oder es wird schon ein Makro ausgeführt. Dieses muß dann vorher gestoppt werden, bevor ein neues Makro ausgeführt werden kann.

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

BOOL TSteering::StartUp ( const HWND hwnd,

const int mid,

TDetector * d

)

Setzt das Fenster, das für die Aktualisierung des Detektors zuständig ist (cm_CounterSet).
Zusätzlich muß der zu verwendende Antrieb und Detektor angegeben werden.
Parameter:

hwnd Das Ausgabefenster.

mid ID des Antriebes.

d Der Detektor.

Rückgabe:
Gibt immer true zurück.

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

BOOL TSteering::ToggleInterrupt ( void )

Pausiert die Makroverarbeitung bzw.
setzt diese wieder fort.
Rückgabe:
Gibt true zurück, falls die Verarbeitung angehalten wurde. Wird die Verarbeitung wieder fortgesetzt, so liefert der Aufruf false zurück.

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

void TSteering::Visualising ( BOOL a,

BOOL b

)

Regelt, wie Fortschrittsanzeigen (während der Kommando-/Makroverarbeitung) auszugeben sind.

Parameter:

a Falls true, so wird SendReport aktiviert.

b Falls true, so wird die ReportList aktiviert.

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