---

IConversionSvc Class Reference

The conversion service interface allows to:

• Add and remove data converters from the sercvice. More...

  #include <GaudiKernel/IConversionSvc.h>

  Inheritance diagram for IConversionSvc:

  List of all members.

  Public Types
  enum	Status { CONVERSIONSVC_NO_ERROR = StatusCode::SUCCESS, NO_CONVERTER, NO_MEMORY, BAD_STORAGE_TYPE }
  	Status code definitions. More...
  Public Methods
  virtual unsigned char	repSvcType () const = 0
  	Retrieve the class type of the data store the converter uses. More...
  virtual StatusCode	createObj (IOpaqueAddress* pAddress, DataObject*& refpObject) = 0
  	Create a transient representation from another representation of this object. More...
  virtual StatusCode	updateObj (IOpaqueAddress* pAddress, DataObject* pObject) = 0
  	Update a transient representation from another representation of this object. More...
  virtual StatusCode	updateReps (IDataSelector* pSelector) = 0
  	Update the original representation of a collection of transient objects. More...
  virtual StatusCode	createReps (IDataSelector* pSelector) = 0
  	Convert a collection of transient data objects into another representation. More...
  virtual StatusCode	setStore (IDataProviderSvc* pStore) = 0
  	Set the transient data store to the service. More...
  virtual StatusCode	addConverter (IConverter* pConverter) = 0
  	Add converter object to conversion service. More...
  virtual StatusCode	addConverter (const ICnvFactory& refFactory) = 0
  	Add converter object to conversion service. More...
  virtual StatusCode	removeConverter (const CLID& clid) = 0
  	Remove converter object from conversion service (if present). More...
  virtual StatusCode	connectOutput (const std::string& outputFile) = 0
  	Connect the output file to the service. More...
  virtual StatusCode	setAddressCreator (IAddressCreator* creator) = 0
  	Set address creator facility. More...
  Static Public Methods
  const InterfaceID&	interfaceID ()
  	Retrieve interface ID. More...

  ---

  Detailed Description

  The conversion service interface allows to:

  • Add and remove data converters from the sercvice.

  • Create objects using converters: e.g. create the transient representation of a persistent object.
  • convert objects - the opposite of create: e.g. convert transient objects into the persistent representation of these objects. The objects to be converted are defined by a data selector object.
  • update objects which already exist: e.g. update the existing persistent representation of objects which were read from the persistent store and should be modified. The objects to be converted are defined by a data selector object.
  • Class specific aspects of the creation/update/conversion mechanism must be handled by the converters, the common aspects will be handled by the service.

    Author(s):

    Markus Frank

    Version:

    1.0

    Definition at line 49 of file IConversionSvc.h.

    ---

    Member Enumeration Documentation

    enum IConversionSvc::Status

    Status code definitions. Enumeration values: CONVERSIONSVC_NO_ERROR   Success. NO_CONVERTER   No proper converter is availible to the service. NO_MEMORY   Cannot fulfill the request due to lack of memory. BAD_STORAGE_TYPE   Invalid storage type. Reimplemented from IInterface. Definition at line 151 of file IConversionSvc.h.

    ---

    Member Function Documentation

    StatusCode IConversionSvc::addConverter ( const ICnvFactory & refFactory ) [pure virtual]

    Add converter object to conversion service. The converter will immediately be instantiated using the factory and initialized. Parameters: refFactory   Reference to the converter factory. Returns: Status code indicating success or failure. Reimplemented in ConversionSvc.

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

    Add converter object to conversion service. Parameters: pConverter   Pointer to converter object Returns: Status code indicating success or failure. Reimplemented in ConversionSvc.

    StatusCode IConversionSvc::connectOutput ( const std::string & outputFile ) [pure virtual]

    Connect the output file to the service. Parameters: outputFile   String containig output file Returns: Status code indicating success or failure. Reimplemented in ConversionSvc.

    StatusCode IConversionSvc::createObj ( IOpaqueAddress * pAddress, DataObject *& refpObject ) [pure virtual]

    Create a transient representation from another representation of this object. This entrypoint is used e.g. for the creation of a transient object from its persistent representation. The information how to retrieve the object from the persistent store is passed in an opaque manner, hence shielding the service from the underlying technology. Parameters: pAddress   Pointer to opaque address of the object: e.g. the ooRef in case of objectivity refpObject   Reference to pointer where the created transient object will be returned. Returns: Status code indicating success or failure. Reimplemented in ConversionSvc. Referenced by DataSvc::loadObject().

    StatusCode IConversionSvc::createReps ( IDataSelector * pSelector ) [pure virtual]

    Convert a collection of transient data objects into another representation. This entrypoint is used e.g. for the creation of a persistent objects from their transient representation. The selector indicates to the service which objects will have to be updated. Parameters: pSelector   Pointer to DataSelector structure. Returns: Status code indicating success or failure. Reimplemented in ConversionSvc.

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

    Retrieve interface ID. Reimplemented from IInterface. Definition at line 52 of file IConversionSvc.h.

    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: pClass   Pointer to class object Returns: Status code indicating success or failure. Reimplemented in ConversionSvc.

    unsigned char IConversionSvc::repSvcType ( ) const [pure virtual]

    Retrieve the class type of the data store the converter uses. Returns: Class type information about the source data store type the converter will use to retrieve the information. Reimplemented in ConversionSvc.

    StatusCode IConversionSvc::setAddressCreator ( IAddressCreator * creator ) [pure virtual]

    Set address creator facility. Parameters: creator   Reference to address creator interface Returns: Status code indicating success or failure. Reimplemented in ConversionSvc.

    StatusCode IConversionSvc::setStore ( IDataProviderSvc * pDataSvc ) [pure virtual]

    Set the transient data store to the service. Parameters: pStore   Pointer to transient data store. Returns: Status code indicating success or failure. Reimplemented in ConversionSvc.

    StatusCode IConversionSvc::updateObj ( IOpaqueAddress * pAddress, DataObject * pObject ) [pure virtual]

    Update a transient representation from another representation of this object. This entrypoint is used e.g. for the update of a transient object from its persistent representation. The information how to retrieve the object from the persistent store is passed in an opaque manner, hence shielding the service from the underlying technology. Parameters: pAddress   Pointer to opaque address of the object: e.g. the ooRef in case of objectivity pObject   Pointer where the transient resides. Returns: Status code indicating success or failure. Reimplemented in ConversionSvc. Referenced by DataSvc::updateObject().

    StatusCode IConversionSvc::updateReps ( IDataSelector * pSelector ) [pure virtual]

    Update the original representation of a collection of transient objects. This entrypoint is used e.g. for the update of a persistent objects from their transient representation. The transient representation of the object must have been created by the service before it can be updated. The selector indicates to the service which objects will have to be updated. Parameters: pSelector   Pointer to DataSelector structure. Returns: Status code indicating success or failure. Reimplemented in ConversionSvc.

    ---

    The documentation for this class was generated from the following file:
    • IConversionSvc.h

    ---