evio  6.0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
evio::RecordNode Class Reference

This class is used to store relevant info about an evio record (or block) along with its position in a buffer. More...

#include <RecordNode.h>

Public Member Functions

 RecordNode ()=default
 
void clear ()
 Set all internal values to 0. More...
 
uint32_t getLen () const
 Get the record's length in 32-bit words. More...
 
void setLen (uint32_t l)
 Set the record's length in 32-bit words. More...
 
uint32_t getCount () const
 Get the number of events in this record. More...
 
void setCount (uint32_t c)
 Set the number of events in this record. More...
 
size_t getPos () const
 Get the position of this record in the file/buffer. More...
 
void setPos (size_t p)
 Set the position of this record in the file/buffer. More...
 
uint32_t getPlace () const
 Get the place of this record in file/buffer. More...
 
void setPlace (uint32_t p)
 Set the place of this record in file/buffer. More...
 
std::string toString () const
 Get a string representation of this object. More...
 

Friends

class EvioCompactReaderV4
 

Detailed Description

This class is used to store relevant info about an evio record (or block) along with its position in a buffer.

This class was previously called "BlockNode" in java.

Author
timmer Date: 7/22/2019

Constructor & Destructor Documentation

evio::RecordNode::RecordNode ( )
default

Member Function Documentation

void evio::RecordNode::clear ( )
inline

Set all internal values to 0.

Referenced by evio::EvioNode::clearObjects().

uint32_t evio::RecordNode::getCount ( ) const
inline

Get the number of events in this record.

Returns
number of events in this record.
uint32_t evio::RecordNode::getLen ( ) const
inline

Get the record's length in 32-bit words.

Returns
record's length in 32-bit words.
uint32_t evio::RecordNode::getPlace ( ) const
inline

Get the place of this record in file/buffer.

First record = 0, second = 1, etc.

Returns
place of this record in file/buffer.
size_t evio::RecordNode::getPos ( ) const
inline

Get the position of this record in the file/buffer.

Returns
position of this record in the file/buffer..
void evio::RecordNode::setCount ( uint32_t  c)
inline

Set the number of events in this record.

Parameters
cnumber of events in this record.
void evio::RecordNode::setLen ( uint32_t  l)
inline

Set the record's length in 32-bit words.

Parameters
lrecord's length in 32-bit words.
void evio::RecordNode::setPlace ( uint32_t  p)
inline

Set the place of this record in file/buffer.

First record = 0, second = 1, etc.

Parameters
pplace of this record in file/buffer.
void evio::RecordNode::setPos ( size_t  p)
inline

Set the position of this record in the file/buffer.

Parameters
pposition of this record in the file/buffer.
std::string evio::RecordNode::toString ( ) const
inline

Get a string representation of this object.

Returns
string representation of this object.

Friends And Related Function Documentation

friend class EvioCompactReaderV4
friend

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