PPL6-Icon Patrick's Programming Library Version 6.4.21 - Dokumentation
ppl6::CApplication Klassenreferenz

Application Framework. Mehr ...

Öffentliche Methoden

 CApplication ()
 Konstruktor der Klasse. Mehr ...
 
virtual ~CApplication ()
 Destruktor der Klasse. Mehr ...
 
const char * GetArg (const char *argument)
 Wert eines Aufrufparameters zurückgeben. Mehr ...
 
const char * GetArg (int num)
 Bestimmten Parameter zurückgeben. Mehr ...
 
int GetArgc ()
 Anzahl Parameter. Mehr ...
 
const char ** GetArgv ()
 Pointer auf Array mit Parametern. Mehr ...
 
PPL6APPPARAMSGetSystemParameter ()
 Pointer auf interne Systemparameter. Mehr ...
 
bool HaveArg (const char *argument)
 Prüft, ob ein bestimmter Parameter vorhanden ist. Mehr ...
 
int Init (PPL6APPPARAMS *params)
 Interne Initialisierung. Mehr ...
 
virtual int Main ()
 Virtuelle Hauptfunktion. Mehr ...
 

Öffentliche Attribute

Cppl6CorePPLCore
 Pointer auf die Programmweite ppl6::Cppl6Core Klasse. Mehr ...
 

Private Attribute

int argc
 
char ** argv
 
PPL6APPPARAMSstartparam
 

Ausführliche Beschreibung

Beschreibung:
Diese Klasse kann als Framework für eigene Applikationen verwendet werden. Sie abstrahiert einige Betriebssystem- und Komprimierungsabhängige Unterschiede (main vs. WinMain) und stellt eine einheitliche Schnittstelle zum Zugriff auf die übergebenen Parameter zur Verfügung.

Zur Verwendung der Klasse muss lediglich eine Instanz der Klasse abgeleitet werden.

Beispiel:
#include <stdio.h>
#include <string.h>
#include <ppl6.h>
class MyApp : public ppl6::CApplication
{
public:
int Main();
};
PPL6APP(MyApp);
int MyApp::Main()
{
bool bHaveHelpParam=HaveArg("-h");
const char *file=GetArg("-f");
if (bHaveHelpParam) {
printf ("You need to add Parameter -f followed by a filename\n");
return 0;
}
if (file==NULL || strlen(file)==0) {
printf ("no filename\n");
return 1;
}
printf ("Filename: %s\n",file);
return 0;
}

Beschreibung der Konstruktoren und Destruktoren

ppl6::CApplication::CApplication ( )
Beschreibung:
Dies ist der Konstruktor der Klasse. Er initialisiert einige interne Variablen.
ppl6::CApplication::~CApplication ( )
virtual
Beschreibung:
Der Destruktor der Klasse.

Dokumentation der Elementfunktionen

const char * ppl6::CApplication::GetArg ( const char *  argument)
Beschreibung:
Diese Funktion prüft, ob das angegebene Argument bei den Aufrufparametern des Programms dabei war und liefert einen Pointer auf dessen Wert zurück.
Parameter
[in]argumentPointer auf einen String mit dem gesuchten Parameter. Dieser enthält in der Regel sowas wie "-h" oder "--version"
Rückgabe
Wenn das Argument nicht bei den Aufrufparametern vorhanden war, liefert die Funktion NULL zurück. Falls doch, wird ein Pointer auf den String zurückgeleifert, der dem Argument folgt. Dies kann auch ein Pointer auf einen leeren String sein.
const char * ppl6::CApplication::GetArg ( int  num)
Beschreibung:
Mit dieser Funktion kannein bestimmer Parameter anhand seiner Nummer ausgelesen werden. Die Anzahl übergebener Paraneter kann mit der Funktion CApplication::GetArgc ausgelesen werden.
Parameter
[in]numNummer des Parameters
Rückgabe
Pointer auf den Inhalt des Parameters oder NULL, wenn die angegebene Nummer num nicht vorhanden ist.
int ppl6::CApplication::GetArgc ( )
Beschreibung:
Diese Funktion liefert die Anzahl übergebener Parameter zurück.
Rückgabe
Anzahl Parameter
const char ** ppl6::CApplication::GetArgv ( )
Beschreibung:
Diese Funktion liefert einen Pointer auf ein Array mit Parametern zurück. Die Anzahl Parameter kann mit der Funktion CApplication::GetArgc abgefragt werden. Das Array ist identisch wie der Parameter argv bei der C-main-Funktion.
Rückgabe
Pointer auf ein Array mit den Parametern.
PPL6APPPARAMS * ppl6::CApplication::GetSystemParameter ( )
Beschreibung:
Diese Funktion liefert einen Pointer auf eine Struktur mit internen Systemparametern zurück.
Rückgabe
Pointer auf ppl6::PPL6APPPARAMS
bool ppl6::CApplication::HaveArg ( const char *  argument)
Beschreibung:
Diese Funktion prüft, ob das angegebene Argument bei den Aufrufparametern des Programms dabei war.
Parameter
[in]argumentPointer auf einen String mit dem gesuchten Parameter. Dieser enthält in der Regel sowas wie "-h" oder "--version"
Rückgabe
Wenn das Argument bei den Aufrufparametern vorhanden war, liefert die Funktion true zurück, andernfalls false.
int ppl6::CApplication::Init ( PPL6APPPARAMS params)
Beschreibung:
Diese Funktion wird nur intern aufgerufen. Hier werden Betriebssystem-unabhängig die Startparameter initialisiert und anschließend die virtuelle Funktion CApplication::Main aufgerufen.
Parameter
[in]paramsPointer auf eine ppl6::PPL6APPPARAMS Struktur, die je nach Betriebssystem unterschiedlich definiert sein kann.
Rückgabe
Die Funktion liefert den Return-Wert der Main-Funktion zurück, der letztenendlich auch als Returncode des Programms zurückgegeben wird.
int ppl6::CApplication::Main ( )
virtual
Beschreibung:
Dies ist die Hauptfunktion der Klasse, die beim Starten der Anwendung aufgerufen wird. Sie ist als virtuell definiert und hat selbst keine Funktion. Sie muss daher von der abgeleiteten Klasse der Anwendung überschrieben werden.
Rückgabe
Ein Wert, der als Returncode der Anwendung zurückgegeben werden soll.

Dokumentation der Datenelemente

int ppl6::CApplication::argc
private
char** ppl6::CApplication::argv
private
ppl6::CApplication::PPLCore
Beschreibung:
Pointer auf die Programmweite ppl6::Cppl6Core Klasse. Dies wird bei Programmstart automatisch angelegt.
PPL6APPPARAMS* ppl6::CApplication::startparam
private

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