The Gaudi Framework  master (bdbe7744)
Loading...
Searching...
No Matches
Gaudi::IIODataManager Class Referenceabstract

#include </builds/gaudi/Gaudi/GaudiUtils/include/GaudiUtils/IIODataManager.h>

Inheritance diagram for Gaudi::IIODataManager:
Inheritance graph
[legend]
Collaboration diagram for Gaudi::IIODataManager:
Collaboration graph
[legend]

Public Types

enum  FileType { UNKNOWN = 1 , PFN , LFN , FID }
typedef IDataConnection Connection
 Connection type definition.
typedef std::vector< Connection * > Connections
typedef Connection::IoType IoType
Public Types inherited from IInterface
enum class  Status : StatusCode::code_t {
  FAILURE = 0 , SUCCESS = 1 , NO_INTERFACE , VERSMISMATCH ,
  LAST_ERROR
}
 Return status. More...
using iid = Gaudi::InterfaceId<IInterface, 0, 0>
 Interface ID.
using ext_iids = Gaudi::interface_list<iid>
 Extra interfaces.

Public Member Functions

 DeclareInterfaceID (IIODataManager, 2, 0)
 InterfaceID.
virtual StatusCode connectRead (bool keep_open, IDataConnection *con)=0
 Open data stream in read mode.
virtual StatusCode connectWrite (IDataConnection *con, IoType mode=Connection::CREATE, const std::string &doctype="UNKNOWN")=0
 Open data stream in write mode.
virtual StatusCode disconnect (IDataConnection *con)=0
 Release data stream.
virtual Connection * connection (const std::string &dsn) const =0
 Retrieve known connection.
virtual Connections connections (const IInterface *owner) const =0
 Get connection by owner instance (0=ALL).
virtual StatusCode read (IDataConnection *con, void *const data, size_t len)=0
 Read raw byte buffer from input stream.
virtual StatusCode write (IDataConnection *con, const void *data, int len)=0
 Write raw byte buffer to output stream.
virtual long long int seek (IDataConnection *con, long long int where, int origin)=0
 Seek on the file described by ioDesc. Arguments as in ::seek().
Public Member Functions inherited from IInterface
template<Gaudi::IsInterface TARGET>
TARGET * cast ()
template<Gaudi::IsInterface TARGET>
TARGET const * cast () const
template<typename TARGET>
requires ( !Gaudi::IsInterface<TARGET> )
TARGET * cast ()
template<typename TARGET>
requires ( !Gaudi::IsInterface<TARGET> )
TARGET const * cast () const
virtual std::vector< std::string > getInterfaceNames () const =0
 Returns a vector of strings containing the names of all the implemented interfaces.
virtual unsigned long addRef () const =0
 Increment the reference count of Interface instance.
virtual unsigned long release () const =0
 Release Interface instance.
virtual unsigned long refCount () const =0
 Current reference count.
virtual StatusCode queryInterface (const InterfaceID &ti, void **pp)=0
 Set the void** to the pointer to the requested interface of the instance.
virtual ~IInterface ()=default
 Virtual destructor.
virtual void const * i_cast (const InterfaceID &) const =0
void * i_cast (const InterfaceID &iidiid)

Additional Inherited Members

Static Public Member Functions inherited from IInterface
static const InterfaceID & interfaceID ()
 Return an instance of InterfaceID identifying the interface.
Protected Member Functions inherited from IInterface
virtual unsigned long decRef () const =0
 Decrement reference count and return the new reference count.

Detailed Description

Author
M.Frank
Version
1.0
Date
20/10/2007
Author
M.Frank
Version
1.0
Date
20/10/2007
Author
R. Lambert
Date
03/09/2009

Definition at line 97 of file IIODataManager.h.

Member Typedef Documentation

◆ Connection

typedef IDataConnection Gaudi::IIODataManager::Connection

Connection type definition.

Definition at line 103 of file IIODataManager.h.

◆ Connections

typedef std::vector<Connection*> Gaudi::IIODataManager::Connections

Definition at line 104 of file IIODataManager.h.

◆ IoType

typedef Connection::IoType Gaudi::IIODataManager::IoType

Definition at line 105 of file IIODataManager.h.

Member Enumeration Documentation

◆ FileType

enum Gaudi::IIODataManager::FileType
Enumerator
UNKNOWN 
PFN 
LFN 
FID 

Definition at line 106 of file IIODataManager.h.

106{ UNKNOWN = 1, PFN, LFN, FID };

Member Function Documentation

◆ connection()

virtual Connection * Gaudi::IIODataManager::connection ( const std::string & dsn) const
pure virtual

Retrieve known connection.

◆ connections()

virtual Connections Gaudi::IIODataManager::connections ( const IInterface * owner) const
pure virtual

Get connection by owner instance (0=ALL).

◆ connectRead()

virtual StatusCode Gaudi::IIODataManager::connectRead ( bool keep_open,
IDataConnection * con )
pure virtual

Open data stream in read mode.

◆ connectWrite()

virtual StatusCode Gaudi::IIODataManager::connectWrite ( IDataConnection * con,
IoType mode = Connection::CREATE,
const std::string & doctype = "UNKNOWN" )
pure virtual

Open data stream in write mode.

◆ DeclareInterfaceID()

Gaudi::IIODataManager::DeclareInterfaceID ( IIODataManager ,
2 ,
0  )

InterfaceID.

◆ disconnect()

virtual StatusCode Gaudi::IIODataManager::disconnect ( IDataConnection * con)
pure virtual

Release data stream.

◆ read()

virtual StatusCode Gaudi::IIODataManager::read ( IDataConnection * con,
void *const data,
size_t len )
pure virtual

Read raw byte buffer from input stream.

◆ seek()

virtual long long int Gaudi::IIODataManager::seek ( IDataConnection * con,
long long int where,
int origin )
pure virtual

Seek on the file described by ioDesc. Arguments as in ::seek().

◆ write()

virtual StatusCode Gaudi::IIODataManager::write ( IDataConnection * con,
const void * data,
int len )
pure virtual

Write raw byte buffer to output stream.

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