Gaudi::IDataConnection Class Reference

ABC describing basic data connection. More...

#include <GaudiUtils/IIODataManager.h>

Inheritance diagram for Gaudi::IDataConnection:

Collaboration diagram for Gaudi::IDataConnection:

Public Types
enum	IoType { READ = 1 << 1, UPDATE = 1 << 2, CREATE = 1 << 3, RECREATE = ( 1 << 4 ) + ( 1 << 3 ) }
	I/O Connection types. More...
enum	IoStatus { BAD_DATA_CONNECTION = 4 }
	Status Code on bad file connection. More...

Public Member Functions
	IDataConnection (const IInterface *own, std::string nam)
	Standard constructor. More...
virtual	~IDataConnection ()=default
	Standard destructor. More...
const std::string &	name () const
	Connection name. More...
void	setFID (std::string fid)
	Set file ID. More...
const std::string &	fid () const
	Access file id. More...
const std::string &	pfn () const
	Access physical file name. More...
void	setPFN (std::string fn)
	Set physical file name. More...
int	ageFile ()
	Increase age of I/O source. More...
void	resetAge ()
	Reset age. More...
int	age () const
	Access age counter. More...
const IInterface *	owner () const
	Owner instance. More...
virtual StatusCode	connectRead ()=0
	Open data stream in read mode. More...
virtual StatusCode	connectWrite (IoType type)=0
	Open data stream in write mode. More...
virtual StatusCode	disconnect ()=0
	Release data stream. More...
virtual bool	isConnected () const =0
	Check if connected to data source. More...
virtual StatusCode	read (void *const data, size_t len)=0
	Read raw byte buffer from input stream. More...
virtual StatusCode	write (const void *data, int len)=0
	Write raw byte buffer to output stream. More...
virtual long long int	seek (long long int where, int origin)=0
	Seek on the file described by ioDesc. Arguments as in ::seek() More...

Protected Attributes
std::string	m_name
	Connection name/identifier. More...
std::string	m_fid
	File ID of the connection. More...
std::string	m_pfn
	Physical file name of the connection. More...
int	m_age = 0
	Age counter. More...
const IInterface *	m_owner = nullptr
	Owner pointer. More...

Detailed Description

ABC describing basic data connection.

Author

M.Frank

Version

1.0

Date

20/10/2007

Definition at line 25 of file IIODataManager.h.

Member Enumeration Documentation

enum Gaudi::IDataConnection::IoStatus

Status Code on bad file connection.

Enumerator
BAD_DATA_CONNECTION

Definition at line 43 of file IIODataManager.h.

{ BAD_DATA_CONNECTION = 4 };

enum Gaudi::IDataConnection::IoType

I/O Connection types.

Enumerator
READ
UPDATE
CREATE
RECREATE

Definition at line 41 of file IIODataManager.h.

{ READ = 1 << 1, UPDATE = 1 << 2, CREATE = 1 << 3, RECREATE = ( 1 << 4 ) + ( 1 << 3 ) };

Constructor & Destructor Documentation

Gaudi::IDataConnection::IDataConnection ( const IInterface *  own, std::string  nam  )

inline

Standard constructor.

Definition at line 47 of file IIODataManager.h.

: m_name( std::move( nam ) ), m_owner( own ) {}

virtual Gaudi::IDataConnection::~IDataConnection ( )

virtualdefault

Standard destructor.

Member Function Documentation

int Gaudi::IDataConnection::age ( ) const

inline

Access age counter.

Definition at line 65 of file IIODataManager.h.

{ return m_age; }

int Gaudi::IDataConnection::ageFile ( )

inline

Increase age of I/O source.

Definition at line 61 of file IIODataManager.h.

{ return ++m_age; }

virtual StatusCode Gaudi::IDataConnection::connectRead ( )

pure virtual

Open data stream in read mode.

Implemented in Gaudi::RootDataConnection.

virtual StatusCode Gaudi::IDataConnection::connectWrite ( IoType  type )

pure virtual

Open data stream in write mode.

Implemented in Gaudi::RootDataConnection.

virtual StatusCode Gaudi::IDataConnection::disconnect ( )

pure virtual

Release data stream.

Implemented in Gaudi::RootDataConnection.

const std::string& Gaudi::IDataConnection::fid ( ) const

inline

Access file id.

Definition at line 55 of file IIODataManager.h.

{ return m_fid; }

virtual bool Gaudi::IDataConnection::isConnected ( ) const

pure virtual

Check if connected to data source.

Implemented in Gaudi::RootDataConnection.

const std::string& Gaudi::IDataConnection::name ( ) const

inline

Connection name.

Definition at line 51 of file IIODataManager.h.

{ return m_name; }

const IInterface* Gaudi::IDataConnection::owner ( ) const

inline

Owner instance.

Definition at line 67 of file IIODataManager.h.

{ return m_owner; }

const std::string& Gaudi::IDataConnection::pfn ( ) const

inline

Access physical file name.

Definition at line 57 of file IIODataManager.h.

{ return m_pfn; }

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

pure virtual

Read raw byte buffer from input stream.

Implemented in Gaudi::RootDataConnection.

void Gaudi::IDataConnection::resetAge ( )

inline

Reset age.

Definition at line 63 of file IIODataManager.h.

{ m_age = 0; }

virtual long long int Gaudi::IDataConnection::seek ( long long int  where, int  origin  )

pure virtual

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

Implemented in Gaudi::RootDataConnection.

void Gaudi::IDataConnection::setFID ( std::string  fid )

inline

Set file ID.

Definition at line 53 of file IIODataManager.h.

{ m_fid = std::move( fid ); }

void Gaudi::IDataConnection::setPFN ( std::string  fn )

inline

Set physical file name.

Definition at line 59 of file IIODataManager.h.

{ m_pfn = std::move( fn ); }

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

pure virtual

Write raw byte buffer to output stream.

Implemented in Gaudi::RootDataConnection.

Member Data Documentation

int Gaudi::IDataConnection::m_age = 0

protected

Age counter.

Definition at line 35 of file IIODataManager.h.

std::string Gaudi::IDataConnection::m_fid

protected

File ID of the connection.

Definition at line 31 of file IIODataManager.h.

std::string Gaudi::IDataConnection::m_name

protected

Connection name/identifier.

Definition at line 29 of file IIODataManager.h.

const IInterface* Gaudi::IDataConnection::m_owner = nullptr

protected

Owner pointer.

Definition at line 37 of file IIODataManager.h.

std::string Gaudi::IDataConnection::m_pfn

protected

Physical file name of the connection.

Definition at line 33 of file IIODataManager.h.

---

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

• GaudiUtils/GaudiUtils/IIODataManager.h