treqs::FilePositionOnTape Class Reference

Defines a relation between a file and a tape/. More...

#include <FilePositionOnTape.h>

Collaboration diagram for treqs::FilePositionOnTape:
Collaboration graph
[legend]

List of all members.

Public Member Functions

 FilePositionOnTape ()
 Constructor.
 ~FilePositionOnTape ()
 Destructor.
FilegetFileRef () const
 Getter for member.
unsigned int getPosition () const
 Getter for member.
TapegetTapeRef () const
 Getter for member.
time_t getMetadataTimestamp () const
 Getter for member.
void setFileRef (File *FileRef)
 Setter for member.
void setPosition (int Position)
 Setter for member.
void setTapeRef (Tape *TapeRef)
 Setter for member.
void setMetadataTimestamp (time_t)
 Setter for member.
bool isMetadataOutdated ()
 test if metadata is fresh enough
std::string getFileName () throw (NoFileRefException)
 Get the HPSS namespace of the file.
void prepareCleanup ()
 Tells the related Tape and File objects to unregister themselves.

Private Attributes

FileFileRef
 References a file.
TapeTapeRef
 References the tape of this file.
int Position
 The position of this file on this tape.
time_t MetadataTimestamp
 The last time metadata were updated.

Static Private Attributes

static LoggerPtr logger

Detailed Description

Defines a relation between a file and a tape/.

This object only contains part of the metadata of the file that is related to the tape. A file can be moved to another tape, and that information is reflected here.

The metadata of the file, such as its name, size and owner are stored in the File object.

The metadata attribute indicates when the information about a file in a tape is considered obsolete. When it is considered obsolete, the information has to be updated.


Constructor & Destructor Documentation

treqs::FilePositionOnTape::FilePositionOnTape (  ) 

Constructor.

treqs::FilePositionOnTape::~FilePositionOnTape (  ) 

Destructor.


Member Function Documentation

std::string treqs::FilePositionOnTape::getFileName (  )  throw (NoFileRefException)

Get the HPSS namespace of the file.

If the file reference is not available, throw an exception

Returns:
the name of the file

Here is the call graph for this function:

Here is the caller graph for this function:

treqs::File * treqs::FilePositionOnTape::getFileRef (  )  const

Getter for member.

Here is the caller graph for this function:

time_t treqs::FilePositionOnTape::getMetadataTimestamp (  )  const

Getter for member.

unsigned int treqs::FilePositionOnTape::getPosition (  )  const

Getter for member.

Here is the caller graph for this function:

treqs::Tape * treqs::FilePositionOnTape::getTapeRef (  )  const

Getter for member.

Here is the caller graph for this function:

bool treqs::FilePositionOnTape::isMetadataOutdated (  ) 

test if metadata is fresh enough

Here is the caller graph for this function:

void treqs::FilePositionOnTape::prepareCleanup (  ) 

Tells the related Tape and File objects to unregister themselves.

Before destroying an instance, the FilePositionOnTapescontroller will call this method.

Here is the call graph for this function:

void treqs::FilePositionOnTape::setFileRef ( treqs::File FileRef  ) 

Setter for member.

Here is the caller graph for this function:

void treqs::FilePositionOnTape::setMetadataTimestamp ( time_t  t  ) 

Setter for member.

void treqs::FilePositionOnTape::setPosition ( int  Position  ) 

Setter for member.

Here is the caller graph for this function:

void treqs::FilePositionOnTape::setTapeRef ( treqs::Tape TapeRef  ) 

Setter for member.

Here is the call graph for this function:

Here is the caller graph for this function:


Member Data Documentation

References a file.

LoggerPtr treqs::FilePositionOnTape::logger [static, private]

The last time metadata were updated.

The position of this file on this tape.

References the tape of this file.


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

Generated on 4 Mar 2010 for TReqS by  doxygen 1.6.1