SH::DiskOutput Class Reference

a class representing an output location for files More...

#include <DiskOutput.h>

Inheritance diagram for SH::DiskOutput:

List of all members.

Public Member Functions
void	testInvariant () const
	test the invariant of this object
	DiskOutput ()
	standard constructor
DiskWriter *	makeWriter (const std::string &sample, const std::string &name, int index, const std::string &suffix) const
	create a writer object for a file with the id
Protected Member Functions
virtual DiskWriter *	doMakeWriter (const std::string &sample, const std::string &name, int index, const std::string &suffix) const
	ClassDef (DiskOutput, 1)

---

Detailed Description

a class representing an output location for files

Rationale

This is used by EventLoop to specify locations where output n-tuples should go if they are not to be stored in the submission directory

Rationale

This inherits from TObject, so that it can be written to a file

Warning:

This interface may still change, if new output types are added that need new functionality.

---

Constructor & Destructor Documentation

SH::DiskOutput::DiskOutput

(

)

standard constructor

Guarantee

strong

Failures

out of memory I

---

Member Function Documentation

virtual DiskWriter* SH::DiskOutput::doMakeWriter	(	const std::string &	sample,
		const std::string &	name,
		int	index,
		const std::string &	suffix
	)			const [protected, virtual]

create a writer object for a file with the id

Parameters:

	sample	the name of the sample this belongs to
	name	the name of the file to create
	index	the index of the file within the sample, or otherwise -1
	suffix	the suffix to use for the file

Returns:

the writer object

Precondition:

!sample.empty() || !name.empty()

index >= -1

Postcondition:

result != 0

Guarantee

strong

Failures

out of memory II

Failures

i/o errors rationale: you don't need to set all of these, but you need to set at least either the name or the sample.

Rationale

the virtual part of DiskOutput::makeWriter

Reimplemented in SH::DiskOutputLocal, and SH::DiskOutputXRD.

DiskWriter* SH::DiskOutput::makeWriter	(	const std::string &	sample,
		const std::string &	name,
		int	index,
		const std::string &	suffix
	)			const

create a writer object for a file with the id

Parameters:

	sample	the name of the sample this belongs to
	name	the name of the file to create
	index	the index of the file within the sample, or otherwise -1
	suffix	the suffix to use for the file

Returns:

the writer object

Precondition:

!sample.empty() || !name.empty()

index >= -1

Postcondition:

result != 0

Guarantee

strong

Failures

out of memory II

Failures

i/o errors rationale: you don't need to set all of these, but you need to set at least either the name or the sample.

void SH::DiskOutput::testInvariant

(

)

const

test the invariant of this object

Guarantee

no-fail

Reimplemented in SH::DiskOutputLocal, and SH::DiskOutputXRD.

---

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

• /cvmfs/atlas.cern.ch/repo/sw/ASG/AnalysisBase/2.4.31/SampleHandler/SampleHandler/DiskOutput.h