Public Member Functions | List of all members
DebugTrace_T Class Reference

Detailed Description

This test is really just a compile-time test to make sure that DebugTrace compiles on whatever platform it's being built on.

Definition at line 48 of file DebugTrace_T.cpp.

Inheritance diagram for DebugTrace_T:
Inheritance graph
[legend]

Public Member Functions

void additionalSetup () override
 
void completeProcessing () override
 
 DebugTrace_T (const string &applName)
 
void doSomething ()
 
bool initialize (int argc, char *argv[], bool pretty=true) noexcept override
 
void process () override
 
void shutDown () override
 
void spinUp () override
 
- Public Member Functions inherited from gnsstk::BasicFramework
 BasicFramework (const std::string &applName, const std::string &applDesc) noexcept
 
bool run () noexcept
 
virtual ~BasicFramework ()
 Destructor. More...
 

Additional Inherited Members

- Public Attributes inherited from gnsstk::BasicFramework
int exitCode
 
- Static Public Attributes inherited from gnsstk::BasicFramework
static const int EXCEPTION_ERROR = 1
 
static const int EXIST_ERROR = 2
 
static const int GENERAL_ERROR = 1
 
static const int OPTION_ERROR = 2
 
- Protected Attributes inherited from gnsstk::BasicFramework
std::string appDesc
 Description of program's function. More...
 
std::string argv0
 Name of the program. More...
 
int debugLevel
 Debug level for this run of the program. More...
 
CommandOptionNoArg debugOption
 Enable/increase debugging output. More...
 
CommandOptionHelpUsage helpOption
 Request command-line option usage. More...
 
int verboseLevel
 Verbose level for this run of the program. More...
 
CommandOptionNoArg verboseOption
 Enable/increase informational output. More...
 

Constructor & Destructor Documentation

◆ DebugTrace_T()

DebugTrace_T::DebugTrace_T ( const string &  applName)
inline

Definition at line 51 of file DebugTrace_T.cpp.

Member Function Documentation

◆ additionalSetup()

void DebugTrace_T::additionalSetup ( )
inlineoverridevirtual

Additional set-up to be performed before starting processing. This generally involves things that are necessary for either the spinUp processing or main processing. This method should be implemeneted by the end-user.

Reimplemented from gnsstk::BasicFramework.

Definition at line 73 of file DebugTrace_T.cpp.

◆ completeProcessing()

void DebugTrace_T::completeProcessing ( )
inlineoverridevirtual

Called by the run() method; calls additionalSetup(), spinUp(), and process(), in that order. Generally should not be overridden.

Reimplemented from gnsstk::BasicFramework.

Definition at line 68 of file DebugTrace_T.cpp.

◆ doSomething()

void DebugTrace_T::doSomething ( )
inline

Definition at line 100 of file DebugTrace_T.cpp.

◆ initialize()

bool DebugTrace_T::initialize ( int  argc,
char *  argv[],
bool  pretty = true 
)
inlineoverridevirtualnoexcept

Process command line arguments. When this method is overridden, make sure to call the parent class's initialize().

Parameters
[in]argcsame as main() argc.
[in]argvsame as main() argv.
[in]prettyWhether the 'pretty print' option will be used when printing descriptions. It is 'TRUE' by default.
Returns
true if normal processing should proceed (i.e. no command line errors or help requests).

Reimplemented from gnsstk::BasicFramework.

Definition at line 54 of file DebugTrace_T.cpp.

◆ process()

void DebugTrace_T::process ( )
inlineoverridevirtual

Processing to be performed. This method should be implemeneted by the end-user.

Reimplemented from gnsstk::BasicFramework.

Definition at line 83 of file DebugTrace_T.cpp.

◆ shutDown()

void DebugTrace_T::shutDown ( )
inlineoverridevirtual

Clean-up processing to be done before the program ends. This method is executed outside of a try block and should be implemeneted by the end-user.

Reimplemented from gnsstk::BasicFramework.

Definition at line 95 of file DebugTrace_T.cpp.

◆ spinUp()

void DebugTrace_T::spinUp ( )
inlineoverridevirtual

Code to be executed AFTER initialize() and additionalSetup(). This method should be implemeneted by the end-user.

Reimplemented from gnsstk::BasicFramework.

Definition at line 78 of file DebugTrace_T.cpp.


The documentation for this class was generated from the following file:


gnsstk
Author(s):
autogenerated on Wed Oct 25 2023 02:40:43