MCsh class

the foundation MC context class More...

Files
file	mcsh.h
	Class MCsh: the foundation MC context class.
Classes
struct	sMCsh
	Class MCsh: Definition. More...
Typedefs
typedef struct sMCsh	MCsh
	Declaration of the MCsh class as the MCsh structure.
Functions
MCsh *	MCsh_ctor (PDE *tpde, int argc, char **argv)
	The MCsh constructor.
void	MCsh_dtor (MCsh **thee)
	The MCsh destructor.
int	MCsh_shell (MCsh *thee, int(*USER_shell)(void *thee, int argc, char **argv))
	The actuall shell.
int	MCsh_pshell (MCsh *thee, int(*USER_shell)(void *thee, int argc, char **argv))
	The actuall shell (version with parallel extensions).
void	MCsh_memChk (MCsh *thee)
	Print the exact current malloc usage.

---

Detailed Description

the foundation MC context class

---

Typedef Documentation

typedef struct sMCsh MCsh

Declaration of the MCsh class as the MCsh structure.

Author:

Michael Holst

---

Function Documentation

MCsh* MCsh_ctor	(	PDE *	tpde,
		int	argc,
		char **	argv
	)

The MCsh constructor.

Author:

Michael Holst

Note:

Class MCsh: Non-inlineable methods (mcsh.c)

Returns:

Pointer to a new allocated MCsh shell

Parameters:

	tpde	Pointer to the PDE object
	argc	number of the command line arguments
	argv	the command line arguments

void MCsh_dtor

(

MCsh **

thee

)

The MCsh destructor.

Author:

Michael Holst

Note:

Class MCsh: Non-inlineable methods (mcsh.c)

Returns:

None

Parameters:

thee

Pointer to a MCsh shell

void MCsh_memChk

(

MCsh *

thee

)

Print the exact current malloc usage.

Author:

Michael Holst

Note:

Class MCsh: Non-inlineable methods (mcsh.c)

Returns:

None

Parameters:

thee

Pointer to a MCsh shell

int MCsh_pshell	(	MCsh *	thee,
		int(*)(void *thee, int argc, char **argv)	USER_shell
	)

The actuall shell (version with parallel extensions).

Author:

Michael Holst

Note:

Class MCsh: Non-inlineable methods (mcsh.c)

Returns:

Success enumeration

Parameters:

	thee	Pointer to a MCsh shell
	USER_shell	Pointer to a user-defined shell

int MCsh_shell	(	MCsh *	thee,
		int(*)(void *thee, int argc, char **argv)	USER_shell
	)

The actuall shell.

Author:

Michael Holst

Note:

Class MCsh: Non-inlineable methods (mcsh.c)

Returns:

Success enumeration

Parameters:

	thee	Pointer to a MCsh shell
	USER_shell	Pointer to a user-defined shell