| The Gaudi Framework v32r1 (f65d50dc)

Public Member Functions | Static Public Member Functions | Protected Attributes | List of all members
NTuple::File Class Reference

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

`#include <GaudiKernel/NTuple.h>`

Inheritance diagram for NTuple::File:
[legend]
Collaboration diagram for NTuple::File:
[legend]

## Public Member Functions
| File ()=default
| File (long type, std::string name, std::string logName)
| Standard constructor. More...
const CLID & | clID () 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::string & | name () const
| Retrun physical file name. More...
void | setName (std::string nam)
| Set access type. More...
const std::string & | logicalName () 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...
DataObject & | operator= (const DataObject &rhs)
| Assignment Operator. More...
| DataObject (DataObject &&rhs)
| Move Constructor. More...
DataObject & | operator= (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::string & | name () 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...
IRegistry * | registry () const
| Get pointer to Registry. More...
LinkManager * | linkMgr () const
| Retrieve Link manager. More...
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::ostream & | fillStream (std::ostream &s) const
| Fill the output stream (ASCII) More...

## Static Public Member Functions
static const CLID & | classID ()
| class ID of the object More...
Static Public Member Functions inherited from NTuple::Directory
static const CLID & | classID ()
| class ID of the object More...
Static Public Member Functions inherited from DataObject
static const CLID & | classID ()
| 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 910 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 924 of file NTuple.h.

925 : m_name( std::move( name ) ), m_logName( std::move( logName ) ), m_type( type ) {}
NTuple::File::m_logName
std::string m_logName
Logical file name.
Definition: NTuple.h:915
NTuple::File::m_type
long m_type
Access type.
Definition: NTuple.h:917
NTuple::File::name
const std::string & name() const
Retrun physical file name.
Definition: NTuple.h:936
NTuple::File::m_name
std::string m_name
Physical file name.
Definition: NTuple.h:913
std::move
T move(T... args)
NTuple::File::type
long type() const
Return access type.
Definition: NTuple.h:934

## Member Function Documentation

## ◆ classID()

static const CLID& NTuple::File::classID | ( |  | ) |
| inline static

class ID of the object

Definition at line 928 of file NTuple.h.

928 { return CLID_NTupleFile; }

## ◆ clID()

const CLID& NTuple::File::clID | ( |  | ) | const
| inline override virtual

class ID of the object

Reimplemented from NTuple::Directory.

Definition at line 930 of file NTuple.h.

930 { return classID(); }
NTuple::File::classID
static const CLID & classID()
class ID of the object
Definition: NTuple.h:928

## ◆ isOpen()

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

Access "open" flag.

Definition at line 946 of file NTuple.h.

946 { return m_isOpen; }
NTuple::File::m_isOpen
bool m_isOpen
Flag to indicate wether the file was opened already.
Definition: NTuple.h:919

## ◆ logicalName()

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

Definition at line 940 of file NTuple.h.

940 { return m_logName; }
NTuple::File::m_logName
std::string m_logName
Logical file name.
Definition: NTuple.h:915

## ◆ name()

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

Retrun physical file name.

Definition at line 936 of file NTuple.h.

936 { return m_name; }
NTuple::File::m_name
std::string m_name
Physical file name.
Definition: NTuple.h:913

## ◆ setLogicalName()

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

Definition at line 942 of file NTuple.h.

942 { m_logName = std::move( l ); }
NTuple::File::m_logName
std::string m_logName
Logical file name.
Definition: NTuple.h:915
std::move
T move(T... args)
gaudirun.l
dictionary l
Definition: gaudirun.py:521

## ◆ setName()

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

Set access type.

Definition at line 938 of file NTuple.h.

938 { m_name = std::move( nam ); }
NTuple::File::m_name
std::string m_name
Physical file name.
Definition: NTuple.h:913
std::move
T move(T... args)

## ◆ setOpen()

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

Set "open" flag.

Definition at line 944 of file NTuple.h.

944 { m_isOpen = flag; }
NTuple::File::m_isOpen
bool m_isOpen
Flag to indicate wether the file was opened already.
Definition: NTuple.h:919

## ◆ setType()

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

Set access type.

Definition at line 932 of file NTuple.h.

932 { m_type = typ; }
NTuple::File::m_type
long m_type
Access type.
Definition: NTuple.h:917

## ◆ type()

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

Return access type.

Definition at line 934 of file NTuple.h.

934 { return m_type; }
NTuple::File::m_type
long m_type
Access type.
Definition: NTuple.h:917

## Member Data Documentation

## ◆ m_isOpen

bool NTuple::File::m_isOpen = false
| protected

Flag to indicate wether the file was opened already.

Definition at line 919 of file NTuple.h.

## ◆ m_logName

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

Logical file name.

Definition at line 915 of file NTuple.h.

## ◆ m_name

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

Physical file name.

Definition at line 913 of file NTuple.h.

## ◆ m_type

long NTuple::File::m_type = 0
| protected

Access type.

Definition at line 917 of file NTuple.h.

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

- GaudiKernel/GaudiKernel/NTuple.h