The Gaudi Framework  master (d98a2936)
IConversionSvc.h
Go to the documentation of this file.
1 /***********************************************************************************\
2 * (c) Copyright 1998-2025 CERN for the benefit of the LHCb and ATLAS collaborations *
3 * *
4 * This software is distributed under the terms of the Apache version 2 licence, *
5 * copied verbatim in the file "LICENSE". *
6 * *
7 * In applying this licence, CERN does not waive the privileges and immunities *
8 * granted to it by virtue of its status as an Intergovernmental Organization *
9 * or submit itself to any jurisdiction. *
10 \***********************************************************************************/
11 #pragma once
12 
13 #include <GaudiKernel/IConverter.h>
14 #include <string>
15 
16 class ICnvFactory;
17 
43 class GAUDI_API IConversionSvc : virtual public IConverter {
44 public:
47 
52  virtual StatusCode addConverter( IConverter* pConverter ) = 0;
53 
58  virtual StatusCode addConverter( const CLID& clid ) = 0;
59 
65  virtual StatusCode removeConverter( const CLID& clid ) = 0;
66 
71  virtual IConverter* converter( const CLID& clid ) = 0;
72 
77  virtual StatusCode connectOutput( const std::string& outputFile ) = 0;
78 
84  virtual StatusCode connectOutput( const std::string& outputFile, const std::string& openMode ) = 0;
85 
95  virtual StatusCode commitOutput( const std::string& outputFile, bool do_commit ) = 0;
96 
98  enum class Status : StatusCode::code_t {
100  INVALID_ADDRESS = static_cast<StatusCode::code_t>( IInterface::Status::LAST_ERROR ) + 1,
102  INVALID_OBJECT,
104  NO_MEMORY,
106  BAD_STORAGE_TYPE,
108  NO_SOURCE_OBJECT,
110  NO_CONVERTER
111  };
112 };
113 
IConversionSvc::commitOutput
virtual StatusCode commitOutput(const std::string &outputFile, bool do_commit)=0
Commit pending output.
IConverter
Definition: IConverter.h:65
StatusCode::code_t
unsigned long code_t
type of StatusCode value
Definition: StatusCode.h:66
IConversionSvc::removeConverter
virtual StatusCode removeConverter(const CLID &clid)=0
Remove converter object from conversion service (if present).
StatusCode
Definition: StatusCode.h:64
IConversionSvc::connectOutput
virtual StatusCode connectOutput(const std::string &outputFile, const std::string &openMode)=0
Connect the output file to the service with open mode.
CLID
unsigned int CLID
Class ID definition.
Definition: ClassID.h:16
IConversionSvc::addConverter
virtual StatusCode addConverter(IConverter *pConverter)=0
Add converter object to conversion service.
IInterface::Status::LAST_ERROR
@ LAST_ERROR
Last error.
IConverter.h
IConversionSvc::connectOutput
virtual StatusCode connectOutput(const std::string &outputFile)=0
Connect the output file to the service.
STATUSCODE_ENUM_DECL
#define STATUSCODE_ENUM_DECL(ENUM)
Declare an enum to be used as StatusCode value.
Definition: StatusCode.h:286
IConversionSvc::DeclareInterfaceID
DeclareInterfaceID(IConversionSvc, 4, 0)
InterfaceID.
IConversionSvc::converter
virtual IConverter * converter(const CLID &clid)=0
Retrieve converter from list.
GAUDI_API
#define GAUDI_API
Definition: Kernel.h:49
IConversionSvc::addConverter
virtual StatusCode addConverter(const CLID &clid)=0
Add converter object to conversion service.
IConversionSvc::Status
Status
Status code definitions.
Definition: IConversionSvc.h:98
IConversionSvc
Definition: IConversionSvc.h:43