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

Lightweight wrapper for a raw data pointer with type, size, and offset metadata. More...

#include <record.h>

Public Member Functions

 data ()
 Construct an empty data object with a null pointer and zero size. More...
 
 ~data ()=default
 Default destructor. More...
 
void setDataPtr (const char *__ptr)
 Set the raw data pointer. More...
 
void setDataSize (int __size)
 Set the data size in bytes. More...
 
void setDataOffset (int __offset)
 Set the byte offset into the source buffer. More...
 
void setDataEndianness (int __endianness)
 Set the endianness indicator for the data. More...
 
void setDataType (int __type)
 Set the data type identifier. More...
 
const uint32_t * getEvioPtr ()
 Return the data pointer cast to a uint32_t pointer (EVIO format). More...
 
int getEvioSize ()
 Return the data size in 4-byte (uint32_t) units. More...
 
const char * getDataPtr ()
 Return the raw data pointer. More...
 
int getDataSize ()
 Return the data size in bytes. More...
 
int getDataType ()
 Return the data type identifier. More...
 
int getDataEndianness ()
 Return the endianness indicator. More...
 
int getDataOffset ()
 Return the byte offset into the source buffer. More...
 

Detailed Description

Lightweight wrapper for a raw data pointer with type, size, and offset metadata.

Does not own the underlying memory; it simply provides typed access to a region of a larger buffer.

Definition at line 91 of file record.h.

Constructor & Destructor Documentation

◆ data()

hipo::data::data ( )
inline

Construct an empty data object with a null pointer and zero size.

Definition at line 101 of file record.h.

◆ ~data()

hipo::data::~data ( )
default

Default destructor.

Member Function Documentation

◆ getDataEndianness()

int hipo::data::getDataEndianness ( )
inline

Return the endianness indicator.

Definition at line 126 of file record.h.

◆ getDataOffset()

int hipo::data::getDataOffset ( )
inline

Return the byte offset into the source buffer.

Definition at line 128 of file record.h.

◆ getDataPtr()

const char* hipo::data::getDataPtr ( )
inline

Return the raw data pointer.

Definition at line 120 of file record.h.

◆ getDataSize()

int hipo::data::getDataSize ( )
inline

Return the data size in bytes.

Definition at line 122 of file record.h.

◆ getDataType()

int hipo::data::getDataType ( )
inline

Return the data type identifier.

Definition at line 124 of file record.h.

◆ getEvioPtr()

const uint32_t* hipo::data::getEvioPtr ( )
inline

Return the data pointer cast to a uint32_t pointer (EVIO format).

Definition at line 116 of file record.h.

◆ getEvioSize()

int hipo::data::getEvioSize ( )
inline

Return the data size in 4-byte (uint32_t) units.

Definition at line 118 of file record.h.

◆ setDataEndianness()

void hipo::data::setDataEndianness ( int  __endianness)
inline

Set the endianness indicator for the data.

Definition at line 112 of file record.h.

◆ setDataOffset()

void hipo::data::setDataOffset ( int  __offset)
inline

Set the byte offset into the source buffer.

Definition at line 110 of file record.h.

◆ setDataPtr()

void hipo::data::setDataPtr ( const char *  __ptr)
inline

Set the raw data pointer.

Definition at line 106 of file record.h.

◆ setDataSize()

void hipo::data::setDataSize ( int  __size)
inline

Set the data size in bytes.

Definition at line 108 of file record.h.

◆ setDataType()

void hipo::data::setDataType ( int  __type)
inline

Set the data type identifier.

Definition at line 114 of file record.h.


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