SPARK Problem Driver Application Programming Interface

This document provides detailed information on the classes and functions used in the implementation of the driver function. We refer to this set of preprocessor macros, classes, types and functions as the SPARK Problem Driver Application Programming Interface (API).

List of classes

• the SPARK::TProblem class
• the SPARK::TComponent class
• the SPARK::TInverse class
• the SPARK::TObject class

• the SPARK::TRuntimeControls class
• the SPARK::TGlobalSettings class
• the SPARK::TComponentSettings class
• the SPARK::TPreferenceSettings class

List of typedefs and enums

• the enum SPARK::ExitCodes returned by the driver function

List of functions

Functions used to manage the simulation session:

• SPARK::Start()
• SPARK::End()
• SPARK::ExitWithError()

Utility functions :

• SPARK::Log()
• SPARK::GetFileName()

General access functions:

• SPARK::GetProgramName()
• SPARK::GetBaseName()
• SPARK::GetVersion()

• SPARK::GetRunLog()
• SPARK::GetRunLogFilename()

• SPARK::GetErrorLog()
• SPARK::GetErrorLogFilename()

Functions used to manage the SPARK::TProblem objects:

• SPARK::Problem::StaticBuild::ParseCommandLine()
• SPARK::Problem::StaticBuild::ShowCommandLineUsage()
• SPARK::Problem::StaticBuild::Load()

• SPARK::Problem::DynamicBuild::ParseCommandLine()
• SPARK::Problem::DynamicBuild::ShowCommandLineUsage()
• SPARK::Problem::DynamicBuild::Load()

• SPARK::Problem::Unload()
• SPARK::Problem::Get()
• SPARK::Problem::Initialize()
• SPARK::Problem::LoadPreferenceSettings()
• SPARK::Problem::Terminate()
• SPARK::Problem::Save()
• SPARK::Problem::Restore()
• SPARK::Problem::Simulate()
• SPARK::Problem::Step()
• SPARK::Problem::StaticStep()

---