HIPO  4.3.0
High Performance Output data format for experimental physics
hipo::tuple Class Reference

N-tuple writer for storing columnar float data in HIPO files. More...

#include <tuple.h>

Public Member Functions

 tuple ()
 Default constructor. More...
 
 tuple (const char *format)
 Construct a tuple with the given column format string. More...
 
virtual ~tuple ()
 
void open (const char *file)
 Open an output HIPO file. More...
 
void initBranches (int size)
 Initialize internal branch structures. More...
 
void setVerbose (int level)
 Set the writer verbosity level. More...
 
void fill (const float *array)
 Fill a row of values into the tuple. More...
 
void close ()
 Close the output file. More...
 

Protected Member Functions

void writeAndUpdate ()
 Write the current event and prepare for the next one. More...
 

Detailed Description

N-tuple writer for storing columnar float data in HIPO files.

Provides a simple interface for writing rows of float values as structures in a HIPO file.

Definition at line 71 of file tuple.h.

Constructor & Destructor Documentation

◆ tuple() [1/2]

hipo::tuple::tuple ( )

Default constructor.

Definition at line 46 of file tuple.cpp.

◆ tuple() [2/2]

hipo::tuple::tuple ( const char *  format)

Construct a tuple with the given column format string.

Parameters
formatColumn format descriptor

Definition at line 50 of file tuple.cpp.

◆ ~tuple()

hipo::tuple::~tuple ( )
virtual

Definition at line 53 of file tuple.cpp.

Member Function Documentation

◆ close()

void hipo::tuple::close ( )

Close the output file.

Definition at line 78 of file tuple.cpp.

◆ fill()

void hipo::tuple::fill ( const float *  array)

Fill a row of values into the tuple.

Parameters
arrayPointer to an array of float values (one per column)

Definition at line 66 of file tuple.cpp.

◆ initBranches()

void hipo::tuple::initBranches ( int  size)

Initialize internal branch structures.

Parameters
sizeNumber of branches (columns)

Definition at line 60 of file tuple.cpp.

◆ open()

void hipo::tuple::open ( const char *  file)

Open an output HIPO file.

Parameters
filePath to the output file

Definition at line 74 of file tuple.cpp.

◆ setVerbose()

void hipo::tuple::setVerbose ( int  level)
inline

Set the writer verbosity level.

Definition at line 100 of file tuple.h.

◆ writeAndUpdate()

void hipo::tuple::writeAndUpdate ( )
protected

Write the current event and prepare for the next one.

Definition at line 82 of file tuple.cpp.


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