| Classes | Job Modules | Data Objects | Services | Algorithms | Tools | Packages | Directories | Tracs |

In This Package:

NTuple::File Class Reference

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

#include <NTuple.h>

Inheritance diagram for NTuple::File:

[legend]
Collaboration diagram for NTuple::File:
[legend]
List of all members.

inline code of class DataObject

void setRegistry (IRegistry *pRegistry)
 Set pointer to Registry.
IRegistryregistry () const
 Get pointer to Registry.
LinkManagerlinkMgr () const
 Retrieve Link manager.
unsigned char version () const
 Retrieve version number of this object representation.
void setVersion (unsigned char vsn)
 Set version number of this object representation.
unsigned long refCount () const
 Return the refcount.
virtual std::ostream & fillStream (std::ostream &s) const
 Fill the output stream (ASCII).
std::ostream & operator<< (std::ostream &s, const DataObject &obj)
 Output operator (ASCII).

Public Member Functions

 File ()
 File (long type, const std::string name, const std::string &logName)
 Standard constructor.
virtual ~File ()
 Standard destructor.
virtual const CLIDclID () const
 class ID of the object
void setType (const long typ)
 Set access type.
long type () const
 Return access type.
const std::string & name () const
 Retrun physical file name.
void setName (const std::string &nam)
 Set access type.
const std::string & logicalName () const
void setLogicalName (const std::string &l)
void setOpen (bool flag)
 Set "open" flag.
bool isOpen () const
 Access "open" flag.
virtual unsigned long addRef ()
 Add reference to object.
virtual unsigned long release ()
 release reference to object
virtual StreamBufferserialize (StreamBuffer &s)
 Serialization mechanism: Serialize the object for reading.
virtual StreamBufferserialize (StreamBuffer &s) const
 Serialization mechanism: Serialize the object for writing.

Static Public Member Functions

static const CLIDclassID ()
 class ID of the object

Protected Attributes

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

Detailed Description

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

Definition at line 1083 of file NTuple.h.


Constructor & Destructor Documentation

NTuple::File::File (  )  [inline]

Definition at line 1094 of file NTuple.h.

01094            : m_type(0), m_isOpen(false)   {
01095     }

NTuple::File::File ( long  type,
const std::string  name,
const std::string &  logName 
) [inline]

Standard constructor.

Definition at line 1097 of file NTuple.h.

01098     : m_name(name), m_logName(logName), m_type(type), m_isOpen(false)  {
01099     }

virtual NTuple::File::~File (  )  [inline, virtual]

Standard destructor.

Definition at line 1101 of file NTuple.h.

01101                       {
01102     }


Member Function Documentation

static const CLID& NTuple::File::classID (  )  [inline, static]

class ID of the object

Reimplemented from NTuple::Directory.

Definition at line 1104 of file NTuple.h.

01104                                     {
01105       return CLID_NTupleFile;
01106     }

virtual const CLID& NTuple::File::clID (  )  const [inline, virtual]

class ID of the object

Reimplemented from NTuple::Directory.

Definition at line 1108 of file NTuple.h.

01108                                           {
01109       return File::classID();
01110     }

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

Set access type.

Definition at line 1112 of file NTuple.h.

01112                                    {
01113       m_type = typ;
01114     }

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

Return access type.

Definition at line 1116 of file NTuple.h.

01116                            {
01117       return m_type;
01118     }

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

Retrun physical file name.

Reimplemented from DataObject.

Definition at line 1120 of file NTuple.h.

01120                                        {
01121       return m_name;
01122     }

void NTuple::File::setName ( const std::string &  nam  )  [inline]

Set access type.

Definition at line 1124 of file NTuple.h.

01124                                           {
01125       m_name = nam;
01126     }

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

Definition at line 1128 of file NTuple.h.

01128                                               {
01129       return m_logName;
01130     }

void NTuple::File::setLogicalName ( const std::string &  l  )  [inline]

Definition at line 1132 of file NTuple.h.

01132                                               {
01133       m_logName = l;
01134     }

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

Set "open" flag.

Definition at line 1136 of file NTuple.h.

01136                                 {
01137       m_isOpen = flag;
01138     }

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

Access "open" flag.

Definition at line 1140 of file NTuple.h.

01140                             {
01141       return m_isOpen;
01142     }

virtual unsigned long DataObject::addRef (  )  [virtual, inherited]

Add reference to object.

virtual unsigned long DataObject::release (  )  [virtual, inherited]

release reference to object

virtual StreamBuffer& DataObject::serialize ( StreamBuffer s  )  [virtual, inherited]

Serialization mechanism: Serialize the object for reading.

Reimplemented in RefTableBase< FROM, MAPENTRY >, RefTableBase< FROM, SmartRefVector< TO > >, and RefTableBase< FROM, SmartRef< TO > >.

virtual StreamBuffer& DataObject::serialize ( StreamBuffer s  )  const [virtual, inherited]

Serialization mechanism: Serialize the object for writing.

Reimplemented in RefTableBase< FROM, MAPENTRY >, RefTableBase< FROM, SmartRefVector< TO > >, and RefTableBase< FROM, SmartRef< TO > >.

void DataObject::setRegistry ( IRegistry pRegistry  )  [inline, inherited]

Set pointer to Registry.

Definition at line 67 of file DataObject.h.

00067                                             {
00068     m_pRegistry = pRegistry;
00069   }

IRegistry* DataObject::registry (  )  const [inline, inherited]

Get pointer to Registry.

Definition at line 71 of file DataObject.h.

00071                                 {
00072     return m_pRegistry;
00073   }

LinkManager* DataObject::linkMgr (  )  const [inline, inherited]

Retrieve Link manager.

Definition at line 75 of file DataObject.h.

00075                                     {
00076     return m_pLinkMgr;
00077   }

unsigned char DataObject::version (  )  const [inline, inherited]

Retrieve version number of this object representation.

Definition at line 79 of file DataObject.h.

00079                                     {
00080     return m_version;
00081   }

void DataObject::setVersion ( unsigned char  vsn  )  [inline, inherited]

Set version number of this object representation.

Definition at line 83 of file DataObject.h.

00083                                         {
00084     m_version = vsn;
00085   }

unsigned long DataObject::refCount (  )  const [inline, inherited]

Return the refcount.

Definition at line 87 of file DataObject.h.

00087                                  {
00088     return m_refCount;
00089   }

virtual std::ostream& DataObject::fillStream ( std::ostream &  s  )  const [inline, virtual, inherited]

Fill the output stream (ASCII).

Reimplemented in ObjectList< TYPE >, and ObjectVector< TYPE >.

Definition at line 91 of file DataObject.h.

00091                                                         {
00092     s << "DataObject at " << std::hex << this;
00093     return s;
00094   }


Friends And Related Function Documentation

std::ostream& operator<< ( std::ostream &  s,
const DataObject obj 
) [friend, inherited]

Output operator (ASCII).

Definition at line 96 of file DataObject.h.

00096                                                                          {
00097     return obj.fillStream(s);
00098   }


Member Data Documentation

std::string NTuple::File::m_name [protected]

Physical file name.

Definition at line 1086 of file NTuple.h.

std::string NTuple::File::m_logName [protected]

Logical file name.

Definition at line 1088 of file NTuple.h.

long NTuple::File::m_type [protected]

Access type.

Definition at line 1090 of file NTuple.h.

bool NTuple::File::m_isOpen [protected]

Flag to indicate wether the file was opened already.

Definition at line 1092 of file NTuple.h.


The documentation for this class was generated from the following file:
| Classes | Job Modules | Data Objects | Services | Algorithms | Tools | Packages | Directories | Tracs |

Generated on Mon Apr 11 19:57:19 2011 for GaudiKernel by doxygen 1.4.7