#include <jive/app/ControlModule.h>

Inheritance diagram for jive::app::ControlModule:

Public Member Functions
	ControlModule (const String &name="control", const Ref< Module > &child=NIL, int mode=0)

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)

void	setMode (int mode)

int	getMode () const

String	getPrompt () const

void	setPrompt (const String &prompt)

void	runWhile (const String &expr)

void	printHelp (PrintWriter &out) const

Public Member Functions inherited from jive::app::Module
	Module (const String &name="")

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 Member Functions
static Ref< Module >	makeNew (const String &name, const Properties &conf, const Properties &props, const Properties &globdat)

static void	declare ()

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...

Static Public Attributes
static const char *	TYPE_NAME

static const int	FG_MODE

Static Public Attributes inherited from jive::app::Module
static const char *	CASE_NAME

Protected Member Functions
virtual	~ControlModule ()

Protected Member Functions inherited from jive::app::Module
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...

Friends
class	RootData_

class	ProcData_

Additional Inherited Members
Public Types inherited from jive::app::Module
enum	Status { OK, DONE, EXIT }

Protected Attributes inherited from jem::NamedObject
String	myName_

Constructor & Destructor Documentation

jive::app::ControlModule::ControlModule	(	const String &	name = `"control"`,
		const Ref< Module > &	child = `NIL`,
		int	mode = `0`
	)

explicit

virtual jive::app::ControlModule::~ControlModule ( )

protectedvirtual

Member Function Documentation

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

virtual

Reimplemented from jive::app::Module.

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

virtual

Reimplemented from jive::app::Module.

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

virtual

Reimplemented from jive::app::Module.

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

virtual

Reimplemented from jive::app::Module.

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

virtual

Reimplemented from jive::app::Module.

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

virtual

Reimplemented from jive::app::Module.

void jive::app::ControlModule::setMode ( int mode )

int jive::app::ControlModule::getMode ( ) const

String jive::app::ControlModule::getPrompt ( ) const

void jive::app::ControlModule::setPrompt ( const String & prompt )

void jive::app::ControlModule::runWhile ( const String & expr )

void jive::app::ControlModule::printHelp ( PrintWriter & out ) const

static Ref<Module> jive::app::ControlModule::makeNew	(	const String &	name,
		const Properties &	conf,
		const Properties &	props,
		const Properties &	globdat
	)

static

static void jive::app::ControlModule::declare ( )

static

Friends And Related Function Documentation

friend class RootData_

friend

friend class ProcData_

friend

Member Data Documentation

const char* jive::app::ControlModule::TYPE_NAME

static

const int jive::app::ControlModule::FG_MODE

static

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Friends

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation