SH::DiskWriterLocal Class Reference

an implementation of DiskWriter for local files More...

#include <DiskWriterLocal.h>

Inheritance diagram for SH::DiskWriterLocal:

Collaboration diagram for SH::DiskWriterLocal:

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

Private Member Functions
virtual std::string	getPath () const
	the path where this file can be accessed or the empty string if it is not known (yet). More...
virtual TFile *	getFile ()
	the file we are writing to More...
virtual void	doClose ()
	closes the file we are writing to More...

Private Attributes
std::string	m_path
	the path being used More...
TFile *	m_file
	the actual file object More...

Detailed Description

an implementation of DiskWriter for local files

See also

DiskOutputLocal

Definition at line 20 of file DiskWriterLocal.h.

Constructor & Destructor Documentation

DiskWriterLocal()

SH::DiskWriterLocal::DiskWriterLocal

(

const std::string &

val_path

)

standard constructor

Guarantee

strong

Failures

out of memory I

Precondition

!val_path.empty()

Definition at line 34 of file DiskWriterLocal.cxx.

    : m_path (val_path)
  {
    RCU_REQUIRE (!val_path.empty());
 
    std::string dir = gSystem->DirName (val_path.c_str());
    gSystem->mkdir (dir.c_str(), true);
    m_file = new TFile (val_path.c_str(), "RECREATE");
 
    RCU_NEW_INVARIANT (this);
  }

~DiskWriterLocal()

SH::DiskWriterLocal::~DiskWriterLocal

(

)

standard destructor

Guarantee

no-fail

Definition at line 49 of file DiskWriterLocal.cxx.

  {
    RCU_DESTROY_INVARIANT (this);
 
    if (m_file != 0)
    {
      try
      {
    close ();
      } catch (std::exception& e)
      {
    std::cerr << "exception closing file " << m_path << ": "
          << e.what() << std::endl;
    
      } catch (...)
      {
    std::cerr << "unknown exception closing file " << m_path << std::endl;
      }
    }
  }

Member Function Documentation

close()

void SH::DiskWriter::close ( )

inherited

closes the file we are writing to

Guarantee

basic

Failures

i/o errors
file already closed

Definition at line 66 of file DiskWriter.cxx.

  {
    RCU_CHANGE_INVARIANT (this);
 
    doClose ();
  }

doClose()

void SH::DiskWriterLocal::doClose ( )

privatevirtual

closes the file we are writing to

Guarantee

basic

Failures

i/o errors
file already closed

Rationale

the virtual part of DiskWriter::close

Implements SH::DiskWriter.

Definition at line 92 of file DiskWriterLocal.cxx.

  {
    RCU_CHANGE_INVARIANT (this);
    RCU_REQUIRE2_SOFT (m_file != 0, "file already closed");
 
    if (m_file->Write () < 0)
      RCU_THROW_MSG ("failed to write to file: " + m_path);
    m_file->Close ();
    delete m_file;
    m_file = 0;
  }

file()

TFile * SH::DiskWriter::file ( )

inherited

the file we are writing to

Guarantee

strong

Failures

file already closed

Postcondition

result != 0

Definition at line 54 of file DiskWriter.cxx.

  {
    RCU_CHANGE_INVARIANT (this);
 
    TFile *result = getFile ();
    RCU_REQUIRE (result != 0);
    return result;
  }

getFile()

TFile * SH::DiskWriterLocal::getFile ( )

privatevirtual

the file we are writing to

Guarantee

strong

Failures

file already closed

Postcondition

result != 0

Rationale

the virtual part of DiskWriter::file

Implements SH::DiskWriter.

Definition at line 82 of file DiskWriterLocal.cxx.

  {
    RCU_CHANGE_INVARIANT (this);
    RCU_REQUIRE2_SOFT (m_file != 0, "file already closed");
    return m_file;
  }

getPath()

std::string SH::DiskWriterLocal::getPath ( ) const

privatevirtual

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.

Rationale

the virtual part of DiskWriter::path

Implements SH::DiskWriter.

Definition at line 73 of file DiskWriterLocal.cxx.

  {
    RCU_READ_INVARIANT (this);
    return m_path;
  }

path()

std::string SH::DiskWriter::path ( ) const

inherited

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.

Definition at line 45 of file DiskWriter.cxx.

  {
    RCU_READ_INVARIANT (this);
    return getPath ();
  }

testInvariant()

void SH::DiskWriterLocal::testInvariant

(

)

const

test the invariant of this object

Guarantee

no-fail

Definition at line 27 of file DiskWriterLocal.cxx.

  {
  }

Member Data Documentation

m_file

TFile* SH::DiskWriterLocal::m_file

private

the actual file object

Definition at line 84 of file DiskWriterLocal.h.

m_path

std::string SH::DiskWriterLocal::m_path

private

the path being used

Definition at line 80 of file DiskWriterLocal.h.

---

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

• DiskWriterLocal.h
• DiskWriterLocal.cxx