The Gaudi Framework  master (37c0b60a)
NTuple::File Class Reference

Small class representing an N tuple file in the transient store. More...

#include </builds/gaudi/Gaudi/GaudiKernel/include/GaudiKernel/NTuple.h>

Inheritance diagram for NTuple::File:
Collaboration diagram for NTuple::File:

Public Member Functions

 File ()=default
 
 File (long type, std::string name, std::string logName)
 Standard constructor. More...
 
const CLIDclID () const override
 class ID of the object More...
 
void setType (const long typ)
 Set access type. More...
 
long type () const
 Return access type. More...
 
const std::stringname () const
 Retrun physical file name. More...
 
void setName (std::string nam)
 Set access type. More...
 
const std::stringlogicalName () const
 
void setLogicalName (std::string l)
 
void setOpen (bool flag)
 Set "open" flag. More...
 
bool isOpen () const
 Access "open" flag. More...
 
- Public Member Functions inherited from DataObject
 DataObject ()
 Standard Constructor. More...
 
 DataObject (const DataObject &rhs)
 Copy Constructor. More...
 
DataObjectoperator= (const DataObject &rhs)
 Assignment Operator. More...
 
 DataObject (DataObject &&rhs)
 Move Constructor. More...
 
DataObjectoperator= (DataObject &&rhs)
 Move Assignment Operator. More...
 
virtual ~DataObject ()
 Standard Destructor. More...
 
virtual unsigned long addRef ()
 Add reference to object. More...
 
virtual unsigned long release ()
 release reference to object More...
 
const std::stringname () const
 Retreive DataObject name. It is the name when registered in the store. More...
 
virtual StatusCode update ()
 Provide empty placeholder for internal object reconfiguration callback. More...
 
void setRegistry (IRegistry *pRegistry)
 Set pointer to Registry. More...
 
IRegistryregistry () const
 Get pointer to Registry. More...
 
LinkManagerlinkMgr ()
 Retrieve Link manager. More...
 
const LinkManagerlinkMgr () const
 
unsigned char version () const
 Retrieve version number of this object representation. More...
 
void setVersion (unsigned char vsn)
 Set version number of this object representation. More...
 
unsigned long refCount () const
 Return the refcount. More...
 
virtual std::ostreamfillStream (std::ostream &s) const
 Fill the output stream (ASCII) More...
 

Static Public Member Functions

static const CLIDclassID ()
 class ID of the object More...
 
- Static Public Member Functions inherited from NTuple::Directory
static const CLIDclassID ()
 class ID of the object More...
 
- Static Public Member Functions inherited from DataObject
static const CLIDclassID ()
 Retrieve reference to class definition structure (static access) More...
 

Protected Attributes

std::string m_name
 Physical file name. More...
 
std::string m_logName
 Logical file name. More...
 
long m_type = 0
 Access type. More...
 
bool m_isOpen = false
 Flag to indicate wether the file was opened already. More...
 

Detailed Description

Small class representing an N tuple file in the transient store.

Definition at line 923 of file NTuple.h.

Constructor & Destructor Documentation

◆ File() [1/2]

NTuple::File::File ( )
default

◆ File() [2/2]

NTuple::File::File ( long  type,
std::string  name,
std::string  logName 
)
inline

Standard constructor.

Definition at line 937 of file NTuple.h.

938  : m_name( std::move( name ) ), m_logName( std::move( logName ) ), m_type( type ) {}

Member Function Documentation

◆ classID()

static const CLID& NTuple::File::classID ( )
inlinestatic

class ID of the object

Definition at line 941 of file NTuple.h.

941 { return CLID_NTupleFile; }

◆ clID()

const CLID& NTuple::File::clID ( ) const
inlineoverridevirtual

class ID of the object

Reimplemented from NTuple::Directory.

Definition at line 943 of file NTuple.h.

943 { return classID(); }

◆ isOpen()

bool NTuple::File::isOpen ( ) const
inline

Access "open" flag.

Definition at line 959 of file NTuple.h.

959 { return m_isOpen; }

◆ logicalName()

const std::string& NTuple::File::logicalName ( ) const
inline

Definition at line 953 of file NTuple.h.

953 { return m_logName; }

◆ name()

const std::string& NTuple::File::name ( ) const
inline

Retrun physical file name.

Definition at line 949 of file NTuple.h.

949 { return m_name; }

◆ setLogicalName()

void NTuple::File::setLogicalName ( std::string  l)
inline

Definition at line 955 of file NTuple.h.

955 { m_logName = std::move( l ); }

◆ setName()

void NTuple::File::setName ( std::string  nam)
inline

Set access type.

Definition at line 951 of file NTuple.h.

951 { m_name = std::move( nam ); }

◆ setOpen()

void NTuple::File::setOpen ( bool  flag)
inline

Set "open" flag.

Definition at line 957 of file NTuple.h.

957 { m_isOpen = flag; }

◆ setType()

void NTuple::File::setType ( const long  typ)
inline

Set access type.

Definition at line 945 of file NTuple.h.

945 { m_type = typ; }

◆ type()

long NTuple::File::type ( ) const
inline

Return access type.

Definition at line 947 of file NTuple.h.

947 { return m_type; }

Member Data Documentation

◆ m_isOpen

bool NTuple::File::m_isOpen = false
protected

Flag to indicate wether the file was opened already.

Definition at line 932 of file NTuple.h.

◆ m_logName

std::string NTuple::File::m_logName
protected

Logical file name.

Definition at line 928 of file NTuple.h.

◆ m_name

std::string NTuple::File::m_name
protected

Physical file name.

Definition at line 926 of file NTuple.h.

◆ m_type

long NTuple::File::m_type = 0
protected

Access type.

Definition at line 930 of file NTuple.h.


The documentation for this class was generated from the following file:
std::move
T move(T... args)
NTuple::File::m_name
std::string m_name
Physical file name.
Definition: NTuple.h:926
NTuple::File::classID
static const CLID & classID()
class ID of the object
Definition: NTuple.h:941
NTuple::File::m_isOpen
bool m_isOpen
Flag to indicate wether the file was opened already.
Definition: NTuple.h:932
NTuple::File::type
long type() const
Return access type.
Definition: NTuple.h:947
gaudirun.l
dictionary l
Definition: gaudirun.py:583
NTuple::File::name
const std::string & name() const
Retrun physical file name.
Definition: NTuple.h:949
NTuple::File::m_type
long m_type
Access type.
Definition: NTuple.h:930
NTuple::File::m_logName
std::string m_logName
Logical file name.
Definition: NTuple.h:928