Messages

  Copyright (C) 2009-2016 Peter Rakyta, Ph.D.
  This program is free software: you can redistribute it and/or modify
  it under the terms of the GNU General Public License as published by
  the Free Software Foundation, either version 3 of the License, or
  (at your option) any later version.
  This program is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  GNU General Public License for more details.
  You should have received a copy of the GNU General Public License
  along with this program.  If not, see http://www.gnu.org/licenses/.

Description

Returns an interface containing of methodes for displaying several standard messages.

Syntax

interface = Messages( )

Attributes (protected)

  • Opt

    An instance of the structure Opt.

Methods (public)

Methods (public static)

Messages::display

Description

Displays output messages on the screen.

Syntax

object.display( message, nosilent )

Parameters
message The message to be displayed.
nosilent Set true to override the silent option given in structure Opt.



Messages::getOpt

Description

Retrives the structure containing the calculation parameters.

Syntax

ret = object.getOpt()

Returns
ret An instance of structure Opt.



Messages::BadInputType

Description

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

Syntax

object.BadInputType( object, type )

Parameters
object A string containing the name of the variable.
type A string containing the type of the variable.



Messages::BadInputTypeNoDefault

Description

Throws a "bad input type" warning.

Syntax

object.BadInputTypeNoDefault(object, type)

Parameters
object A string containing the name of the variable.
type A string containing the type of the variable.



Messages::ExceedIteration

Description

Throws an "iteration exceeded" warning.

Syntax

object.ExceedIteration()




Tags: 
common messages
interface