SH::DiskWriter Class Reference

an interface that manages writing a single output file More...

#include <DiskWriter.h>

Inheritance diagram for SH::DiskWriter:
SH::DiskWriterLocal SH::DiskWriterXRD

List of all members.

Public Member Functions

void testInvariant () const
 test the invariant of this object
 DiskWriter ()
 standard constructor
virtual ~DiskWriter ()
 standard destructor
std::string path () const
 the path where this file can be accessed or the empty string if it is not known (yet).
TFile * file ()
 the file we are writing to
void close ()
 closes the file we are writing to

Detailed Description

an interface that manages writing a single output file

Rationale
This interface allows to write files to arbitrary storage systems. Most importantly, it allows to execute actions after a file has been closed.
Warning:
This interface may still change, if new output types are added that need new functionality.
See also:
DiskOutput

Constructor & Destructor Documentation

SH::DiskWriter::DiskWriter (  ) 

standard constructor

Guarantee
strong
Failures
out of memory I
SH::DiskWriter::~DiskWriter (  )  [virtual]

standard destructor

Guarantee
no-fail
Rationale
virtual destructor for base class

Member Function Documentation

void SH::DiskWriter::close (  ) 

closes the file we are writing to

Guarantee
basic
Failures
i/o errors
file already closed
TFile * SH::DiskWriter::file (  ) 

the file we are writing to

Guarantee
strong
Failures
file already closed
Postcondition
result != 0
std::string SH::DiskWriter::path ( void   )  const

the path where this file can be accessed or the empty string if it is not known (yet).

Rationale
while it is not guaranteed that every writer will know how to handle this, most writers will, and it can be useful. however, not every writer will know this until after the file is closed.
void SH::DiskWriter::testInvariant (  )  const

test the invariant of this object

Guarantee
no-fail

Reimplemented in SH::DiskWriterLocal, and SH::DiskWriterXRD.


The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines

Generated on 1 Dec 2017 for RootCore Packages by  doxygen 1.6.1