jive::app::Module Class Reference

#include <jive/app/Module.h>

Inherits jem::NamedObject.

Inherited by jive::app::ChainModule, jive::app::CheckpointModule, jive::app::ControlModule, jive::app::DebugModule, jive::app::DummyModule, jive::app::ExitModule, jive::app::GroupconvModule, jive::app::GroupgenModule, jive::app::InfoModule, jive::app::InitModule, jive::app::LoadScaleModule, jive::app::LoopModule, jive::app::OutputModule, jive::app::ReportModule, jive::app::RootOnlyModule, jive::app::SampleModule, jive::app::UserconfModule, jive::fem::BndgenModule, jive::fem::InputModule, jive::fem::MeshpartModule, jive::fem::MPInputModule, jive::fem::PartitionModule, jive::fem::ShapeModule, jive::gl::DisplayModule, jive::gl::GraphModule, jive::gl::ViewModule, jive::implict::EigensolveModule, jive::implict::SolverModule, jive::mesh::BndgenModule, and jive::mesh::MeshgenModule.

Public Types
enum	Status {   OK,   DONE,   EXIT }

Public Member Functions
	Module (const String &name="")
virtual Status	init (const Properties &conf, const Properties &props, const Properties &globdat)
virtual Status	run (const Properties &globdat)
virtual void	shutdown (const Properties &globdat)
virtual void	configure (const Properties &props, const Properties &globdat)
virtual void	getConfig (const Properties &conf, const Properties &globdat) const
virtual bool	takeAction (const String &action, const Properties &params, const Properties &globdat)
virtual String	getContext () const
void	notAliveError () const
void	notAliveError (const String &where) const
Public Member Functions inherited from jem::NamedObject
	NamedObject (const String &name="")
virtual String	toString () const
	Returns a short textual description of this object. More...
String	getName () const
Public Member Functions inherited from jem::Object
virtual Class *	getClass () const
	Returns the Class instance representing the runtime class of this object. More...
virtual long	hashValue () const
	Returns a hash value for this object. More...
virtual bool	equals (const Ref< Object > &obj) const
	Tests whether two objects are equal. More...
Ref< Object >	clone () const
	Returns a copy of this object. More...

Static Public Attributes
static const char *	CASE_NAME

Protected Member Functions
virtual	~Module ()
Protected Member Functions inherited from jem::NamedObject
virtual	~NamedObject ()
Protected Member Functions inherited from jem::Collectable
	Collectable ()
	Creates an empty Collectable. More...
	~Collectable ()
	Frees resources. More...

Additional Inherited Members
Static Public Member Functions inherited from jem::NamedObject
static String	makeContext (const String &kind, const String &name)
Static Public Member Functions inherited from jem::Object
static Class *	getType ()
	Returns the Class instance representing the Object class. More...
Protected Attributes inherited from jem::NamedObject
String	myName_

Member Enumeration Documentation

enum jive::app::Module::Status

Enumerator
OK
DONE
EXIT

Constructor & Destructor Documentation

jive::app::Module::Module ( const String &  name = "" )

explicit

virtual jive::app::Module::~Module ( )

protectedvirtual

Member Function Documentation

virtual Status jive::app::Module::init ( const Properties &  conf, const Properties &  props, const Properties &  globdat  )

virtual

Reimplemented in jive::fem::InputModule, jive::fem::MeshpartModule, jive::gl::ViewModule, jive::app::GroupconvModule, jive::gl::DisplayModule, jive::fem::PartitionModule, jive::app::ControlModule, jive::app::OutputModule, jive::fem::BndgenModule, jive::mesh::BndgenModule, jive::app::DebugModule, jive::app::SampleModule, jive::app::CheckpointModule, jive::app::LoopModule, jive::app::ReportModule, jive::implict::NonlinModule, jive::app::ChainModule, jive::app::InfoModule, jive::app::LoadScaleModule, jive::app::RootOnlyModule, jive::app::UserconfModule, jive::fem::MPInputModule, jive::fem::ShapeModule, jive::gl::FemViewModule, jive::gl::GraphModule, jive::implict::ArclenModule, jive::implict::EigensolveModule, jive::mesh::MeshgenModule, jive::app::DummyModule, jive::app::GroupgenModule, jive::implict::LinsolveModule, jive::app::InitModule, and jive::implict::TransientSolver.

virtual Status jive::app::Module::run ( const Properties &  globdat )

virtual

Reimplemented in jive::gl::ViewModule, jive::gl::DisplayModule, jive::app::ControlModule, jive::app::OutputModule, jive::fem::BndgenModule, jive::app::DebugModule, jive::app::SampleModule, jive::app::CheckpointModule, jive::app::LoopModule, jive::app::ReportModule, jive::app::ChainModule, jive::app::InfoModule, jive::app::LoadScaleModule, jive::app::RootOnlyModule, jive::app::UserconfModule, jive::gl::GraphModule, jive::implict::EigensolveModule, jive::app::DummyModule, jive::implict::TransientSolver, jive::app::ExitModule, and jive::implict::SolverModule.

virtual void jive::app::Module::shutdown ( const Properties &  globdat )

virtual

Reimplemented in jive::gl::ViewModule, jive::gl::DisplayModule, jive::app::ControlModule, jive::app::OutputModule, jive::fem::BndgenModule, jive::app::DebugModule, jive::app::SampleModule, jive::app::CheckpointModule, jive::app::LoopModule, jive::app::ReportModule, jive::app::ChainModule, jive::app::RootOnlyModule, jive::app::UserconfModule, jive::gl::GraphModule, jive::implict::EigensolveModule, jive::app::DummyModule, jive::implict::NonlinModule, jive::implict::ArclenModule, jive::implict::LinsolveModule, jive::app::InitModule, and jive::implict::TransientSolver.

virtual void jive::app::Module::configure ( const Properties &  props, const Properties &  globdat  )

virtual

Reimplemented in jive::gl::ViewModule, jive::gl::DisplayModule, jive::app::ControlModule, jive::app::OutputModule, jive::app::DebugModule, jive::app::SampleModule, jive::app::CheckpointModule, jive::app::LoopModule, jive::app::ReportModule, jive::app::ChainModule, jive::app::RootOnlyModule, jive::app::UserconfModule, jive::gl::GraphModule, jive::implict::EigensolveModule, jive::implict::NonlinModule, jive::app::LoadScaleModule, jive::implict::ArclenModule, jive::implict::LinsolveModule, jive::mesh::BndgenModule, jive::app::InitModule, jive::implict::TransientSolver, jive::fem::ShapeModule, and jive::implict::SolverModule.

virtual void jive::app::Module::getConfig ( const Properties &  conf, const Properties &  globdat  ) const

virtual

Reimplemented in jive::gl::ViewModule, jive::gl::DisplayModule, jive::app::ControlModule, jive::app::OutputModule, jive::app::DebugModule, jive::app::SampleModule, jive::app::CheckpointModule, jive::app::LoopModule, jive::app::ReportModule, jive::app::ChainModule, jive::app::RootOnlyModule, jive::app::UserconfModule, jive::gl::GraphModule, jive::implict::EigensolveModule, jive::implict::NonlinModule, jive::app::LoadScaleModule, jive::implict::ArclenModule, jive::implict::LinsolveModule, jive::mesh::BndgenModule, jive::app::InitModule, jive::implict::TransientSolver, jive::fem::ShapeModule, and jive::implict::SolverModule.

virtual bool jive::app::Module::takeAction ( const String &  action, const Properties &  params, const Properties &  globdat  )

virtual

Reimplemented in jive::gl::ViewModule, jive::gl::DisplayModule, jive::app::ControlModule, jive::app::DebugModule, jive::app::SampleModule, jive::app::CheckpointModule, jive::app::LoopModule, jive::app::ReportModule, jive::app::ChainModule, jive::app::RootOnlyModule, jive::app::UserconfModule, jive::gl::GraphModule, jive::implict::TransientSolver, and jive::app::InfoModule.

virtual String jive::app::Module::getContext ( ) const

virtual

Reimplemented from jem::NamedObject.

void jive::app::Module::notAliveError

(

)

const

void jive::app::Module::notAliveError

(

const String &

where

)

const

Member Data Documentation

const char* jive::app::Module::CASE_NAME

static