Messages Class Reference

A class containing methodes for displaying several standard messages. More...

Inheritance diagram for Messages:

Public Member Functions
function	display (message, nosilent)
	Displays output messages on the screen. More...
function	getOpt ()
	Retrives the structure containing the calculation parameters. More...
function	Messages (Opt)
	Constructor of the class. More...

Static Public Member Functions
static function	BadInputType (variable, type)
	Throws a "bad input type" warning, with using the default value. More...
static function	BadInputTypeNoDefault (variable, type)
	Throws a "bad input type" warning without setting it to default. More...
static function	ExceedIteration ()
	Throws an "iteration exceeded" warning. More...

Protected Attributes
Property	Opt
	An instance of structure Opt. More...

Detailed Description

A class containing methodes for displaying several standard messages.

Definition at line 24 of file Messages.m.

Constructor & Destructor Documentation

Messages()

function Messages::Messages

(

Opt

)

Constructor of the class.

Parameters

Opt	An instance of the structure Opt.

Returns

An instance of the class Messages

Member Function Documentation

BadInputType()

static function Messages::BadInputType ( variable  , type    )

static

Throws a "bad input type" warning, with using the default value.

Parameters

variable	A string conatining the name of the variable.
type	A string describing the desired type.

BadInputTypeNoDefault()

static function Messages::BadInputTypeNoDefault ( variable  , type    )

static

Throws a "bad input type" warning without setting it to default.

Parameters

variable	A string conatining the name of the variable.
type	A string describing the desired type.

display()

function Messages::display	(	message	,
		nosilent
	)

Displays output messages on the screen.

Parameters

message	String containing the message to be displayed
nosilent	Set true to override the silent option given in Opt.Silent.

ExceedIteration()

static function Messages::ExceedIteration ( )

static

Throws an "iteration exceeded" warning.

getOpt()

function Messages::getOpt

(

)

Retrives the structure containing the calculation parameters.

Returns

Return an instance of structure Opt.

Member Data Documentation

Opt

Property Messages::Opt

protected

An instance of structure Opt.

Definition at line 31 of file Messages.m.

---

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

• Messages.m