Gaudi Framework, version v23r0

Home   Generated: Mon Jan 30 2012
Public Types | Public Member Functions

IConversionSvc Class Reference

#include <GaudiKernel/IConversionSvc.h>

Inheritance diagram for IConversionSvc:
Inheritance graph
[legend]
Collaboration diagram for IConversionSvc:
Collaboration graph
[legend]

List of all members.

Public Types

enum  Status { CONVERSIONSVC_NO_ERROR = ICONVERSIONSVC_LAST_ERROR+1, NO_CONVERTER }
 

Status code definitions.

More...

Public Member Functions

 DeclareInterfaceID (IConversionSvc, 4, 0)
 InterfaceID.
virtual StatusCode addConverter (IConverter *pConverter)=0
 Add converter object to conversion service.
virtual StatusCode addConverter (const CLID &clid)=0
 Add converter object to conversion service.
virtual StatusCode removeConverter (const CLID &clid)=0
 Remove converter object from conversion service (if present).
virtual IConverterconverter (const CLID &clid)=0
 Retrieve converter from list.
virtual StatusCode connectOutput (const std::string &outputFile)=0
 Connect the output file to the service.
virtual StatusCode connectOutput (const std::string &outputFile, const std::string &openMode)=0
 Connect the output file to the service with open mode.
virtual StatusCode commitOutput (const std::string &outputFile, bool do_commit)=0
 Commit pending output.

Detailed Description

The conversion service interface allows to:

Author:
Markus Frank
Version:
1.2

Definition at line 38 of file IConversionSvc.h.


Member Enumeration Documentation

Status code definitions.

Enumerator:
CONVERSIONSVC_NO_ERROR 

Success.

NO_CONVERTER 

No proper converter is availible to the service.

Reimplemented from IConverter.

Definition at line 95 of file IConversionSvc.h.


Member Function Documentation

virtual StatusCode IConversionSvc::addConverter ( IConverter pConverter ) [pure virtual]

Add converter object to conversion service.

Parameters:
pConverterPointer to converter object
Returns:
Status code indicating success or failure.
virtual StatusCode IConversionSvc::addConverter ( const CLID clid ) [pure virtual]

Add converter object to conversion service.

Parameters:
clidClass ID of the converter needed
Returns:
Status code indicating success or failure.
virtual StatusCode IConversionSvc::commitOutput ( const std::string outputFile,
bool  do_commit 
) [pure virtual]

Commit pending output.

Parameters:
outputFileString containig output file
do_commitif true commit the output and flush eventually pending items to the database if false, discard pending buffers. Note: The possibility to commit or rollback depends on the database technology used!
Returns:
Status code indicating success or failure.
virtual StatusCode IConversionSvc::connectOutput ( const std::string outputFile,
const std::string openMode 
) [pure virtual]

Connect the output file to the service with open mode.

Parameters:
outputFileString containig output file
openModeString containig opening mode of the output file
Returns:
Status code indicating success or failure.
virtual StatusCode IConversionSvc::connectOutput ( const std::string outputFile ) [pure virtual]

Connect the output file to the service.

Parameters:
outputFileString containig output file
Returns:
Status code indicating success or failure.
virtual IConverter* IConversionSvc::converter ( const CLID clid ) [pure virtual]

Retrieve converter from list.

Parameters:
clidthe clid of the converter
Returns:
the converter corresponding to clid or 0 if non wasa found
IConversionSvc::DeclareInterfaceID ( IConversionSvc  ,
,
 
)
virtual StatusCode IConversionSvc::removeConverter ( const CLID clid ) [pure virtual]

Remove converter object from conversion service (if present).

The converter is defined by the class type of the objects created.

Parameters:
clidClass ID of the converter
Returns:
Status code indicating success or failure.

The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Defines

Generated at Mon Jan 30 2012 13:53:16 for Gaudi Framework, version v23r0 by Doxygen version 1.7.2 written by Dimitri van Heesch, © 1997-2004