The Gaudi Framework  v30r3 (a5ef0a68)
IAddressCreator Class Referenceabstract

IAddressCreator interface definition. More...

#include <GaudiKernel/IAddressCreator.h>

Inheritance diagram for IAddressCreator:
Collaboration diagram for IAddressCreator:

Public Member Functions

 DeclareInterfaceID (IAddressCreator, 3, 0)
 InterfaceID. More...
 
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. More...
 
virtual StatusCode convertAddress (const IOpaqueAddress *pAddress, std::string &refAddress)=0
 Convert an address to string form. More...
 
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. More...
 
- Public Member Functions inherited from IInterface
virtual void * i_cast (const InterfaceID &) const =0
 main cast function More...
 
virtual std::vector< std::stringgetInterfaceNames () const =0
 Returns a vector of strings containing the names of all the implemented interfaces. More...
 
virtual unsigned long addRef ()=0
 Increment the reference count of Interface instance. More...
 
virtual unsigned long release ()=0
 Release Interface instance. More...
 
virtual unsigned long refCount () const =0
 Current reference count. More...
 
virtual StatusCode queryInterface (const InterfaceID &ti, void **pp)=0
 Set the void** to the pointer to the requested interface of the instance. More...
 
virtual ~IInterface ()=default
 Virtual destructor. More...
 

Additional Inherited Members

- Public Types inherited from IInterface
enum  Status : StatusCode::code_t {
  Status::FAILURE = 0, Status::SUCCESS = 1, Status::NO_INTERFACE, Status::VERSMISMATCH,
  Status::LAST_ERROR
}
 Return status. More...
 
using iid = Gaudi::InterfaceId< IInterface, 0, 0 >
 Interface ID. More...
 
using ext_iids = Gaudi::interface_list< iid >
 Extra interfaces. More...
 
- Static Public Member Functions inherited from IInterface
static const InterfaceIDinterfaceID ()
 Return an instance of InterfaceID identifying the interface. More...
 

Detailed Description

IAddressCreator interface definition.

The address creator allows to:

  • Create persistent address representations for a given conversion service using this service itself. The aim is to allow address creation without coupling directly to the service.
Author
Markus Frank
Version
1.0

Definition at line 28 of file IAddressCreator.h.

Member Function Documentation

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

Convert an address to string form.

Parameters
pAddressInput address.
refAddressOutput address in string form.
Returns
Status code indicating success or failure.
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_typeTechnology identifier encapsulated in this address.
clidClass identifier of the DataObject represented by the opaque address
parArray of strings needed to construct the opaque address.
iparArray of integers needed to construct the opaque address.
refpAddressReference to pointer to the address where the created Address should be stored.
Returns
Status code indicating success or failure.
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_typeTechnology identifier encapsulated in this address.
clidClass identifier of the DataObject represented by the opaque address
addressInput address.
refpAddressOutput address in string form.
Returns
Status code indicating success or failure.
IAddressCreator::DeclareInterfaceID ( IAddressCreator  ,
,
 
)

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