| Classes | Job Modules | Data Objects | Services | Algorithms | Tools | Packages | Directories | Tracs |

In This Package:

IAddressCreator Class Reference

IAddressCreator interface definition. More...

#include <GaudiKernel/IAddressCreator.h>

Inheritance diagram for IAddressCreator:

[legend]
Collaboration diagram for IAddressCreator:
[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 createAddress (long svc_type, const CLID &clid, const std::string *par, const unsigned long *ipar, IOpaqueAddress *&refpAddress)=0
 Create a Generic address using explicit arguments to identify a single object.
virtual StatusCode convertAddress (const IOpaqueAddress *pAddress, std::string &refAddress)=0
 Convert an address to string form.
virtual StatusCode createAddress (long svc_type, const CLID &clid, const std::string &refAddress, IOpaqueAddress *&refpAddress)=0
 Creates an address in string form to object form.
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 InterfaceIDinterfaceID ()
 Retrieve interface ID.

Detailed Description

IAddressCreator interface definition.

The address creator allows to:

Author:
Markus Frank
Version:
1.0

Definition at line 32 of file IAddressCreator.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.

00113                 {
00115     SUCCESS = 1,
00117     NO_INTERFACE,
00119     VERSMISMATCH,
00121     LAST_ERROR
00122   };


Member Function Documentation

static const InterfaceID& IAddressCreator::interfaceID (  )  [inline, static]

Retrieve interface ID.

Reimplemented from IInterface.

Definition at line 36 of file IAddressCreator.h.

00036 { return IID_IAddressCreator; }

virtual StatusCode IAddressCreator::createAddress ( long  svc_type,
const CLID clid,
const std::string *  par,
const unsigned long *  ipar,
IOpaqueAddress *&  refpAddress 
) [pure virtual]

Create a Generic address using explicit arguments to identify a single object.

Parameters:
svc_type Technology identifier encapsulated in this address.
clid Class identifier of the DataObject represented by the opaque address
par Array of strings needed to construct the opaque address.
ipar Array of integers needed to construct the opaque address.
refpAddress Reference to pointer to the address where the created Address should be stored.
Returns:
Status code indicating success or failure.

Implemented in ConversionSvc.

virtual StatusCode IAddressCreator::convertAddress ( const IOpaqueAddress pAddress,
std::string &  refAddress 
) [pure virtual]

Convert an address to string form.

Parameters:
pAddress Input address.
refAddress Output address in string form.
Returns:
Status code indicating success or failure.

Implemented in ConversionSvc.

virtual StatusCode IAddressCreator::createAddress ( long  svc_type,
const CLID clid,
const std::string &  refAddress,
IOpaqueAddress *&  refpAddress 
) [pure virtual]

Creates an address in string form to object form.

Parameters:
svc_type Technology identifier encapsulated in this address.
clid Class identifier of the DataObject represented by the opaque address
address Input address.
refpAddress Output address in string form.
Returns:
Status code indicating success or failure.

Implemented in ConversionSvc.

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:
| Classes | Job Modules | Data Objects | Services | Algorithms | Tools | Packages | Directories | Tracs |

Generated on Mon Apr 11 19:57:07 2011 for GaudiKernel by doxygen 1.4.7