In This Package:

IAppMgrUI Class Reference

Application Manager User Interface. More...

#include <GaudiKernel/IAppMgrUI.h>

Inheritance diagram for IAppMgrUI:

[legend]Collaboration diagram for IAppMgrUI:[legend]List of all members.

Public Types
	SUCCESS = 1
	Normal successful completion.
	NO_INTERFACE
	Requested interface is not available.
	VERSMISMATCH
	Requested interface version is incompatible.
	LAST_ERROR
	Last error.
enum	Status { SUCCESS = 1, NO_INTERFACE, VERSMISMATCH, LAST_ERROR }
	Return status. More...
Public Member Functions
virtual StatusCode	run ()=0
	Run the complete job (from intialize to terminate).
virtual StatusCode	configure ()=0
	Configure the job.
virtual StatusCode	terminate ()=0
	Terminate the job.
virtual StatusCode	initialize ()=0
	Initialize the job.
virtual StatusCode	finalize ()=0
	Finalize the job.
virtual StatusCode	nextEvent (int maxevt)=0
	Process the next maxevt events.
virtual const std::string &	name () const =0
	The identifying name of the AppMgrUI object.
virtual StatusCode	start ()=0
	Start (from INITIALIZED to RUNNING).
virtual StatusCode	stop ()=0
	Stop (from RUNNING to INITIALIZED).
virtual StatusCode	reinitialize ()=0
	Initialization (from INITIALIZED or RUNNING to INITIALIZED, via CONFIGURED).
virtual StatusCode	restart ()=0
	Initialization (from RUNNING to RUNNING, via INITIALIZED).
virtual Gaudi::StateMachine::State	FSMState () const =0
	Get the current state.
virtual StatusCode	queryInterface (const InterfaceID &riid, void **ppvInterface)=0
	Query interfaces of Interface.
virtual unsigned long	addRef ()=0
	Increment the reference count of Interface instance.
virtual unsigned long	release ()=0
	Release Interface instance.
Static Public Member Functions
static const InterfaceID &	interfaceID ()
	Retrieve interface ID.

---

Detailed Description

Application Manager User Interface.

This is the interface offered to the UI to control the JOB or Application.

Author:

Pere Mato

Date:

30/10/98

Definition at line 25 of file IAppMgrUI.h.

---

Member Enumeration Documentation

enum IInterface::Status [inherited]

Return status.

Enumerator:

SUCCESS	Normal successful completion.
NO_INTERFACE	Requested interface is not available.
VERSMISMATCH	Requested interface version is incompatible.
LAST_ERROR	Last error.

Reimplemented in IConversionSvc, IConverter, and IDataProviderSvc.

Definition at line 113 of file IInterface.h.

                {
    SUCCESS = 1,
    NO_INTERFACE,
    VERSMISMATCH,
    LAST_ERROR
  };

---

Member Function Documentation

static const InterfaceID& IAppMgrUI::interfaceID

(

)

[inline, static]

Retrieve interface ID.

Reimplemented from IInterface.

Definition at line 28 of file IAppMgrUI.h.

{ return IID_IAppMgrUI; }

virtual StatusCode IAppMgrUI::run

(

)

[pure virtual]

Run the complete job (from intialize to terminate).

virtual StatusCode IAppMgrUI::configure

(

)

[pure virtual]

Configure the job.

virtual StatusCode IAppMgrUI::terminate

(

)

[pure virtual]

Terminate the job.

virtual StatusCode IAppMgrUI::initialize

(

)

[pure virtual]

Initialize the job.

virtual StatusCode IAppMgrUI::finalize

(

)

[pure virtual]

Finalize the job.

virtual StatusCode IAppMgrUI::nextEvent

(

int

maxevt

)

[pure virtual]

Process the next maxevt events.

virtual const std::string& IAppMgrUI::name

(

)

const [pure virtual]

The identifying name of the AppMgrUI object.

virtual StatusCode IAppMgrUI::start

(

)

[pure virtual]

Start (from INITIALIZED to RUNNING).

virtual StatusCode IAppMgrUI::stop

(

)

[pure virtual]

Stop (from RUNNING to INITIALIZED).

virtual StatusCode IAppMgrUI::reinitialize

(

)

[pure virtual]

Initialization (from INITIALIZED or RUNNING to INITIALIZED, via CONFIGURED).

virtual StatusCode IAppMgrUI::restart

(

)

[pure virtual]

Initialization (from RUNNING to RUNNING, via INITIALIZED).

virtual Gaudi::StateMachine::State IAppMgrUI::FSMState

(

)

const [pure virtual]

Get the current state.

virtual StatusCode IInterface::queryInterface	(	const InterfaceID &	riid,
		void **	ppvInterface
	)			[pure virtual, inherited]

Query interfaces of Interface.

Parameters:

	riid	ID of Interface to be retrieved
	ppvInterface	Pointer to Location for interface pointer

Implemented in Algorithm, AlgTool, Auditor, ConversionSvc, Converter, DataSvc, EventSelectorDataStream, MinimalEventLoopMgr, PropertyMgr, SelectStatement, and Service.

virtual unsigned long IInterface::addRef

(

)

[pure virtual, inherited]

Increment the reference count of Interface instance.

Implemented in Algorithm, AlgTool, Auditor, Converter, EventSelectorDataStream, IFactory, PropertyMgr, SelectStatement, and Service.

virtual unsigned long IInterface::release

(

)

[pure virtual, inherited]

Release Interface instance.

Implemented in Algorithm, AlgTool, Auditor, Converter, EventSelectorDataStream, IFactory, PropertyMgr, SelectStatement, and Service.

---

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

• /home/dayabay/installs/trunk_2011_04_11_opt/NuWa-trunk/gaudi/GaudiKernel/GaudiKernel/IAppMgrUI.h

---