ATLAS Offline Software
Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes | List of all members
SH::DiskOutputXRD Class Referencefinal

an implementation of DiskOutput using the XRD protocol More...

#include <DiskOutputXRD.h>

Inheritance diagram for SH::DiskOutputXRD:
Collaboration diagram for SH::DiskOutputXRD:

Public Member Functions

void testInvariant () const
 test the invariant of this object More...
 
 DiskOutputXRD ()
 standard default constructor More...
 
 DiskOutputXRD (const std::string &val_prefix)
 standard constructor More...
 
std::unique_ptr< DiskWritermakeWriter (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< DiskWriterdoMakeWriter (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 (DiskOutputXRD, 1)
 

Private Attributes

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

Detailed Description

an implementation of DiskOutput using the XRD protocol

Rationale
this is to be used when storing output n-tuples on xrootd servers

Definition at line 22 of file DiskOutputXRD.h.

Constructor & Destructor Documentation

◆ DiskOutputXRD() [1/2]

SH::DiskOutputXRD::DiskOutputXRD ( )

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

◆ DiskOutputXRD() [2/2]

SH::DiskOutputXRD::DiskOutputXRD ( const std::string &  val_prefix)
explicit

standard constructor

Guarantee
strong
Failures
out of memory II
Precondition
val_prefix.find ("root://") == 0

Member Function Documentation

◆ ClassDef() [1/2]

SH::DiskOutput::ClassDef ( DiskOutput  ,
 
)
protectedinherited

◆ ClassDef() [2/2]

SH::DiskOutputXRD::ClassDef ( DiskOutputXRD  ,
 
)
private

◆ doMakeWriter()

virtual std::unique_ptr<DiskWriter> SH::DiskOutputXRD::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::DiskOutputXRD::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::DiskOutputXRD::testInvariant ( ) const

test the invariant of this object

Guarantee
no-fail

Member Data Documentation

◆ m_prefix

std::string SH::DiskOutputXRD::m_prefix
private

the prefix to apply when creating files

Definition at line 81 of file DiskOutputXRD.h.


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