sparkapi.h File Reference

Header file defining the functions required to manage the SPARK problems in a driver function. More...

#include <iosfwd>
#include <string>
#include <fstream>
#include "problem.h"
#include "exceptions.h"
#include "compat.h"

Include dependency graph for sparkapi.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Namespaces
namespace	SPARK
namespace	SPARK::Problem::StaticBuild
namespace	SPARK::Problem
namespace	SPARK::Problem::DynamicBuild

---

Detailed Description

Header file defining the functions required to manage the SPARK problems in a driver function.

This file should be included in the C++ source file where the main driver function is implemented.

It defines functions to start, end and exit the simulation session :

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

Utility functions :

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

Access functions :

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

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

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

SPARK problem API functions used to manage 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::Get()
• SPARK::Problem::Unload()
• SPARK::Problem::Initialize()
• SPARK::Problem::LoadPreferenceSettings()
• SPARK::Problem::Terminate()
• SPARK::Problem::Save()
• SPARK::Problem::Restore()
• SPARK::Problem::Simulate()
• SPARK::Problem::Step()
• SPARK::Problem::StaticStep()

Author:

Dimitri Curtil (LBNL/SRG)

Date:

May 21, 2002 Extended API in Sept, 2003

Attention:

PORTIONS COPYRIGHT (C) 2003 AYRES SOWELL ASSOCIATES, INC.
PORTIONS COPYRIGHT (C) 2003 THE REGENTS OF THE UNIVERSITY OF CALIFORNIA . PENDING APPROVAL BY THE US DEPARTMENT OF ENERGY. ALL RIGHTS RESERVED.

---