Detailed Description

template<typename CommandLineT>
class ix::app::command_line_program< CommandLineT >

Definition at line 35 of file IX/include/Application.H.

#include <Application.H>

Public Member Functions
	command_line_program ()

	command_line_program (Global &inglob)

	command_line_program (const std::string &name)

	command_line_program (const std::string &name, int id)

	command_line_program (CommandLineT &incom)

	command_line_program (CommandLineT &incom, Global &inglob)

	command_line_program (int narg, char **args)

virtual int	Initialize ()

CommandLineT &	CommandLine ()

virtual int	Run ()

virtual int	Finalize ()
	Finalizes the global object, and it's profiler object. More...

virtual	~command_line_program ()

Public Member Functions inherited from program2
	program2 ()

	program2 (Global &inglob)

	program2 (int narg, char **args)

	program2 (const std::string &name)

	program2 (const std::string &name, int id)

virtual	~program2 ()

Public Member Functions inherited from GlobalObj< StackType, ErrorType, ProfilerType >
	GlobalObj ()
	Default constructor. Profiling is OFF by default. More...

	GlobalObj (int narg, char **args)
	Default constructor. More...

	GlobalObj (GlobalObj< StackType, ErrorType, ProfilerType > &globin)
	Constructor with args. More...

	GlobalObj (const StackType &name)
	Constructor with args. More...

	GlobalObj (const StackType &name, int id)
	Constructor with args. More...

virtual int	Init (const StackType &name)
	Initializes the global object and it's profiler object /// Initializes the global object and it's profiler object Profiling is ON by default if Init is invoked. More...

virtual int	Init (const StackType &name, unsigned int id)
	Initializes the global object and it's profiler object Profiling is ON by default if Init is invoked. More...

virtual bool	WriteProfiles ()
	Get state of enablement for writing profile files. More...

virtual bool	WriteProfiles (bool yn)
	Enable or disable profile file writing. More...

virtual bool	Profiling ()
	Get profiling state. More...

virtual bool	Profiling (bool yn)
	Enable or disable profiling. More...

virtual void	Report (std::ostream &ReportStream)
	Creates the final profiling report on the specified stream. More...

virtual void	Register (const StackType &stackentry)
	Register will push to the Stack only. More...

virtual void	DeRegister (const StackType &stackentry)
	DeRegister will pop from the stack only. More...

virtual void	FunctionEntry (const StackType &stackentry)
	FunctionEntry updates the Stack as well as the Profiler. More...

virtual void	FunctionExit (const StackType &stackentry)
	FunctionExit updates the Stack as well as the Profiler. More...

virtual void	FunctionExitAll ()
	FunctionExitAll exits all from the Profiler only. More...

virtual void	Error (const ErrorType &error)
	Pushes an error onto the error stack. More...

virtual void	DumpErrors (std::ostream &Ostr)
	Dumps the errors themselves to the indicated stream. More...

virtual void	DumpStack (std::ostream &Ostr)
	Dumps the code construct statck to the indicated stream. More...

virtual void	DumpProfile (std::ostream &Ostr)
	Dumps the timing profile to the indicated stream. More...

bool	DebugStreamReady ()
	Checks debug stream. More...

void	SetDebugStream (std::ostream &dbstream)
	Sets the debug stream object. More...

std::ostream &	DebugStream ()
	Gets the debug stream object. More...

std::ostream *	DebugStreamPtr ()
	Gets the debug stream pointer. More...

bool	ErrStreamReady ()
	Checks error stream. More...

void	SetErrStream (std::ostream &dbstream)
	Sets the error stream object. More...

std::ostream &	ErrStream ()
	Gets the error stream object. More...

std::ostream *	ErrStreamPtr ()
	Gets the error stream pointer. More...

bool	OutStreamReady ()
	Checks out stream. More...

void	SetOutStream (std::ostream &outstream)
	Sets the stdout stream object. More...

std::ostream &	OutStream ()
	Gets the stdout stream object. More...

std::ostream *	OutStreamPtr ()
	Gets the stdout stream pointer. More...

void	UnsetOutStream ()
	Sets outstream to NULL. More...

bool	LogStreamReady ()
	Checks log stream. More...

void	SetLogStream (std::ostream &logstream)
	Sets the stdout stream object. More...

std::ostream &	LogStream ()
	Gets the log stream object. More...

std::ostream *	LogStreamPtr ()
	Gets the log stream pointer. More...

void	SetProfiler (ProfilerType &profiler)
	Sets the Profiler object. More...

virtual void	SetName (const std::string &name)

virtual void	ReName (const std::string &name)

virtual const std::string &	Name ()

ProfilerType &	Profiler ()
	Gets the debug stream object. More...

void	SetDebugLevel (unsigned char l)
	Sets the level of debugging. More...

unsigned char	DebugLevel ()
	Returns the debugging level. More...

void	SetVerbLevel (unsigned char l)

unsigned char	VerbLevel ()
	Returns the verbosity level. More...

void	SetLogLevel (unsigned char l)

unsigned char	LogLevel ()
	Returns the verbosity level. More...

void	DeSyncIO ()
	DeSync IO - relinquish control over IO, revert to standard. More...

void	SyncIO ()
	Syncronize IO - assume control over IO, using established streams. More...

virtual int	ForceOut (const std::string &outstr, unsigned char inlev=1)

virtual int	StdOut (const std::string &outstr, unsigned char inlev=1)

virtual int	ErrOut (const std::string &outstr)

virtual int	DebugOut (const std::string &outstr, int inlev=1)

virtual int	LogOut (const std::string &outstr, int inlev=0)

virtual	~GlobalObj ()
	Destructor. More...

Protected Attributes
CommandLineT	commandLine

Protected Attributes inherited from GlobalObj< StackType, ErrorType, ProfilerType >
std::ostream *	_DebugStream
	DebugStream is useful for parallel programs that cannot stream debugging information to the screen. More...

std::ostream *	_OutStream

std::ostream *	_LogStream

std::ostream *	_ErrStream

ProfilerType *	_Profiler
	This is a placeholder for a generic profiling tool. More...

Inheritance diagram for command_line_program< CommandLineT >:

[legend]

Collaboration diagram for command_line_program< CommandLineT >:

[legend]

Constructor & Destructor Documentation

◆ command_line_program() [1/7]

command_line_program ( )

inline

Definition at line 40 of file IX/include/Application.H.

◆ command_line_program() [2/7]

command_line_program ( Global & inglob )

inline

Definition at line 41 of file IX/include/Application.H.

◆ command_line_program() [3/7]

command_line_program ( const std::string & name )

inline

Definition at line 42 of file IX/include/Application.H.

◆ command_line_program() [4/7]

command_line_program	(	const std::string &	name,
		int	id
	)

inline

Definition at line 43 of file IX/include/Application.H.

◆ command_line_program() [5/7]

command_line_program ( CommandLineT & incom )

inline

Definition at line 44 of file IX/include/Application.H.

◆ command_line_program() [6/7]

command_line_program	(	CommandLineT &	incom,
		Global &	inglob
	)

inline

Definition at line 45 of file IX/include/Application.H.

◆ command_line_program() [7/7]

command_line_program	(	int	narg,
		char **	args
	)

inline

Definition at line 47 of file IX/include/Application.H.

◆ ~command_line_program()

virtual ~command_line_program ( )

inlinevirtual

Definition at line 59 of file IX/include/Application.H.

Member Function Documentation

◆ CommandLine()

CommandLineT& CommandLine ( )

inline

Definition at line 56 of file IX/include/Application.H.

◆ Finalize()

virtual int Finalize ( )

inlinevirtual

Finalizes the global object, and it's profiler object.

Reimplemented from program2.

Definition at line 58 of file IX/include/Application.H.

References program2::Finalize().

Here is the call graph for this function:

◆ Initialize()

virtual int Initialize ( void )

inlinevirtual

Reimplemented from program2.

Definition at line 51 of file IX/include/Application.H.

◆ Run()

virtual int Run ( )

inlinevirtual

Reimplemented from program2.

Definition at line 57 of file IX/include/Application.H.

Member Data Documentation

◆ commandLine

CommandLineT commandLine

protected

Definition at line 38 of file IX/include/Application.H.

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

IX/include/Application.H

Detailed Description

template<typename CommandLineT> class ix::app::command_line_program< CommandLineT >

Public Member Functions

Protected Attributes

Constructor & Destructor Documentation

◆ command_line_program() [1/7]

◆ command_line_program() [2/7]

◆ command_line_program() [3/7]

◆ command_line_program() [4/7]

◆ command_line_program() [5/7]

◆ command_line_program() [6/7]

◆ command_line_program() [7/7]

◆ ~command_line_program()

Member Function Documentation

◆ CommandLine()

◆ Finalize()

◆ Initialize()

◆ Run()

Member Data Documentation

◆ commandLine

template<typename CommandLineT>
class ix::app::command_line_program< CommandLineT >