SH::DiskOutputLocal Class Reference

an implementation of DiskOutput for local disks More...

#include <DiskOutputLocal.h>

Inheritance diagram for SH::DiskOutputLocal:

Collaboration diagram for SH::DiskOutputLocal:

Public Member Functions
void	testInvariant () const
	test the invariant of this object More...
	DiskOutputLocal ()
	standard default constructor More...
	DiskOutputLocal (const std::string &val_prefix)
	standard constructor More...
std::unique_ptr< DiskWriter >	makeWriter (const std::string &sampleName, const std::string &segmentName, const std::string &suffix) const
	create a DiskWriter object managing an output file More...
std::string	targetURL (const std::string &sampleName, const std::string &segmentName, const std::string &suffix) const
	the final output location for the given segment More...

Protected Member Functions
virtual std::unique_ptr< DiskWriter >	doMakeWriter (const std::string &sampleName, const std::string &segmentName, const std::string &suffix) const
	create a DiskWriter object managing an output file More...
virtual std::string	getTargetURL (const std::string &sampleName, const std::string &segmentName, const std::string &suffix) const
	ClassDef (DiskOutput, 1)

Private Member Functions
	ClassDef (DiskOutputLocal, 1)

Private Attributes
std::string	m_prefix
	the prefix to apply when creating files More...

Detailed Description

an implementation of DiskOutput for local disks

Local disks in this case means disks accessed through the file system.

Definition at line 22 of file DiskOutputLocal.h.

Constructor & Destructor Documentation

DiskOutputLocal() [1/2]

SH::DiskOutputLocal::DiskOutputLocal

(

)

standard default constructor

Guarantee

strong

Failures

out of memory I

Warning

this is only to be used for the root streaming mechanism, not by the end user

DiskOutputLocal() [2/2]

SH::DiskOutputLocal::DiskOutputLocal ( const std::string &  val_prefix )

explicit

standard constructor

Guarantee

strong

Failures

out of memory II

Member Function Documentation

ClassDef() [1/2]

SH::DiskOutput::ClassDef ( DiskOutput  , 1    )

protectedinherited

ClassDef() [2/2]

SH::DiskOutputLocal::ClassDef ( DiskOutputLocal  , 1    )

private

doMakeWriter()

virtual std::unique_ptr<DiskWriter> SH::DiskOutputLocal::doMakeWriter ( const std::string &  sampleName, const std::string &  segmentName, const std::string &  suffix  ) const

protectedvirtual

create a DiskWriter object managing an output file

Precondition

!sampleName.empty()

Postcondition

result != nullptr

Guarantee

strong

Failures

out of memory II
i/o errors

Rationale

the virtual part of DiskOutput::makeWriter

Implements SH::DiskOutput.

getTargetURL()

virtual std::string SH::DiskOutputLocal::getTargetURL ( const std::string &  sampleName, const std::string &  segmentName, const std::string &  suffix  ) const

protectedvirtual

Rationale

the virtual part of DiskOutput::targetURL

Implements SH::DiskOutput.

makeWriter()

std::unique_ptr<DiskWriter> SH::DiskOutput::makeWriter ( const std::string &  sampleName, const std::string &  segmentName, const std::string &  suffix  ) const

inherited

create a DiskWriter object managing an output file

Precondition

!sampleName.empty()

Postcondition

result != nullptr

Guarantee

strong

Failures

out of memory II
i/o errors

targetURL()

std::string SH::DiskOutput::targetURL ( const std::string &  sampleName, const std::string &  segmentName, const std::string &  suffix  ) const

inherited

the final output location for the given segment

Precondition

!sampleName.empty()

Postcondition

!result.empty()

Guarantee

strong

Failures

out of memory II

testInvariant()

void SH::DiskOutputLocal::testInvariant

(

)

const

test the invariant of this object

Guarantee

no-fail

Member Data Documentation

m_prefix

std::string SH::DiskOutputLocal::m_prefix

private

the prefix to apply when creating files

Definition at line 83 of file DiskOutputLocal.h.

---

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

• DiskOutputLocal.h