CNORXZ::hdf5::Table Class Reference

#include <h5_table.h>

Inheritance diagram for CNORXZ::hdf5::Table:

Public Types
typedef std::pair< SizeT, String >	FieldID

Public Member Functions
	DEFAULT_MEMBERS (Table)
	Table (const String &name, const ContentBase *_parent)
	~Table ()
virtual ContentType	type () const override final
virtual bool	ro () const override final
virtual Table &	open () override final
virtual Table &	close () override final
virtual String	path () const override final
virtual String	filename () const override final
virtual bool	exists () const override final
Table &	initFieldNames (const Vector< String > &fnames)
Table &	initTable (SizeT n, const void *data, SizeT dsize, SizeT chunk_size)
Table &	appendRecords (SizeT n, const void *data)
Table &	readRecords (SizeT pos, SizeT n, char *data)
MArray< DType >	readRecord (SizeT pos) const
MArray< DType >	read () const
template<class F >
decltype(auto)	iterRecords (F &&f) const
const RangePtr &	fields () const
const RangePtr &	records () const
Public Member Functions inherited from CNORXZ::hdf5::ContentBase
	DEFAULT_MEMBERS (ContentBase)
	ContentBase (const String &_name, const ContentBase *_parent=nullptr)
virtual	~ContentBase ()=default
const String &	name () const
const ContentBase *	parent () const
hid_t	id () const
bool	isOpen () const
template<typename T >
ContentBase &	addAttribute (const String &name, const T &value)
DType	getAttribute (const String &name) const
bool	attributeExists (const String &name) const
std::map< String, DType >	getAttributes () const
std::map< String, DType >	getRecursiveAttributes () const

Protected Member Functions
void	mkTypes ()

Protected Attributes
RangePtr	mRecords
RangePtr	mFields
MArray< SizeT >	mSizes
MArray< SizeT >	mOffsets
MArray< hid_t >	mTypes
hid_t	mType = 0
SizeT	mTypesize = 0
MArray< std::function< DType(const char *)>	mInterpret )
Protected Attributes inherited from CNORXZ::hdf5::ContentBase
String	mName
const ContentBase *	mParent = nullptr
hid_t	mId = 0

Detailed Description

---

Class to handle hdf5 tables.

Definition at line 25 of file h5_table.h.

Member Typedef Documentation

FieldID

typedef std::pair<SizeT,String> CNORXZ::hdf5::Table::FieldID

Meta data type of fields range.

Definition at line 28 of file h5_table.h.

Constructor & Destructor Documentation

Table()

CNORXZ::hdf5::Table::Table	(	const String &	name,
		const ContentBase *	_parent )

Construct the class.

Parameters

name	Table name.
_parent	Parent content object.

Definition at line 19 of file h5_table.cc.

~Table()

CNORXZ::hdf5::Table::~Table

(

)

Destructor. Release all involved hdf5 ids.

Definition at line 58 of file h5_table.cc.

Member Function Documentation

appendRecords()

Table & CNORXZ::hdf5::Table::appendRecords	(	SizeT	n,
		const void *	data )

Append records to the table.

Parameters

n	Number of records to append.
data	Records data.

Definition at line 137 of file h5_table.cc.

close()

Table & CNORXZ::hdf5::Table::close ( )

finaloverridevirtual

Close object.

Returns

Reference to this object.

Implements CNORXZ::hdf5::ContentBase.

Definition at line 83 of file h5_table.cc.

DEFAULT_MEMBERS()

CNORXZ::hdf5::Table::DEFAULT_MEMBERS

(

Table

)

Default constructors and assignments.

exists()

bool CNORXZ::hdf5::Table::exists ( ) const

finaloverridevirtual

Check if group exists in the parent object.

Returns

True if object exists, else false.

Implements CNORXZ::hdf5::ContentBase.

Definition at line 103 of file h5_table.cc.

fields()

const RangePtr & CNORXZ::hdf5::Table::fields

(

)

const

Get fields range.

Returns

Pointer to the range.

Definition at line 184 of file h5_table.cc.

filename()

String CNORXZ::hdf5::Table::filename ( ) const

finaloverridevirtual

Get the file name.

Returns

Name of the hdf5 file this object is stored in.

Implements CNORXZ::hdf5::ContentBase.

Definition at line 98 of file h5_table.cc.

initFieldNames()

Table & CNORXZ::hdf5::Table::initFieldNames

(

const Vector< String > &

fnames

)

Ininitialize table field names.

Parameters

fnames

Table field names.

Definition at line 108 of file h5_table.cc.

initTable()

Table & CNORXZ::hdf5::Table::initTable	(	SizeT	n,
		const void *	data,
		SizeT	dsize,
		SizeT	chunk_size )

Initialize the table.

Parameters

n	Number of records (rows).
data	Table data.
dsize	Record type size.
chunk_size	Chunk size.

Definition at line 120 of file h5_table.cc.

iterRecords()

template<class F >

decltype(auto) CNORXZ::hdf5::Table::iterRecords

(

F &&

f

)

const

Iterate over table records.

Parameters

f	function object to be executed on each table record.

Definition at line 23 of file h5_table.cc.h.

mkTypes()

void CNORXZ::hdf5::Table::mkTypes ( )

protected

Type setup function.

Definition at line 194 of file h5_table.cc.

open()

Table & CNORXZ::hdf5::Table::open ( )

finaloverridevirtual

Open object.

Returns

Reference to this object.

Implements CNORXZ::hdf5::ContentBase.

Definition at line 73 of file h5_table.cc.

path()

String CNORXZ::hdf5::Table::path ( ) const

finaloverridevirtual

Get object path.

Returns

Absolute hdf5 file internal path of this object.

Implements CNORXZ::hdf5::ContentBase.

Definition at line 93 of file h5_table.cc.

read()

MArray< DType > CNORXZ::hdf5::Table::read

(

)

const

Read table.

Returns

DType array containing the table data.

Definition at line 168 of file h5_table.cc.

readRecord()

MArray< DType > CNORXZ::hdf5::Table::readRecord

(

SizeT

pos

)

const

Read record.

Parameters

pos	Number of the record to be read.

Returns

DType array with containing the record data.

Definition at line 153 of file h5_table.cc.

readRecords()

Table & CNORXZ::hdf5::Table::readRecords	(	SizeT	pos,
		SizeT	n,
		char *	data )

Read records.

Parameters

pos	Number of first record to read.
n	Number of records to read.
data	Target pointer.

Definition at line 146 of file h5_table.cc.

records()

const RangePtr & CNORXZ::hdf5::Table::records

(

)

const

Get records range.

Returns

Pointer to the range.

Definition at line 189 of file h5_table.cc.

ro()

bool CNORXZ::hdf5::Table::ro ( ) const

finaloverridevirtual

Check if in read-only mode

Returns

True if read-only else false.

Implements CNORXZ::hdf5::ContentBase.

Definition at line 68 of file h5_table.cc.

type()

ContentType CNORXZ::hdf5::Table::type ( ) const

finaloverridevirtual

Get the content type.

Returns

Content type.

Implements CNORXZ::hdf5::ContentBase.

Definition at line 63 of file h5_table.cc.

Member Data Documentation

mFields

RangePtr CNORXZ::hdf5::Table::mFields

protected

Fields range.

Definition at line 104 of file h5_table.h.

mInterpret

MArray<std::function<DType(const char*)> CNORXZ::hdf5::Table::mInterpret)

protected

Field element type interpreting functions.

Definition at line 110 of file h5_table.h.

mOffsets

MArray<SizeT> CNORXZ::hdf5::Table::mOffsets

protected

Field element offsets.

Definition at line 106 of file h5_table.h.

mRecords

RangePtr CNORXZ::hdf5::Table::mRecords

protected

Records range.

Definition at line 103 of file h5_table.h.

mSizes

MArray<SizeT> CNORXZ::hdf5::Table::mSizes

protected

Field element type sizes.

Definition at line 105 of file h5_table.h.

mType

hid_t CNORXZ::hdf5::Table::mType = 0

protected

Record type id.

Definition at line 108 of file h5_table.h.

mTypes

MArray<hid_t> CNORXZ::hdf5::Table::mTypes

protected

Field element type ids.

Definition at line 107 of file h5_table.h.

mTypesize

SizeT CNORXZ::hdf5::Table::mTypesize = 0

protected

Record type size.

Definition at line 109 of file h5_table.h.

---

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

• /github/workspace/src/opt/hdf5/include/h5_table.h
• /github/workspace/src/opt/hdf5/include/h5_table.cc.h
• /github/workspace/src/opt/hdf5/lib/h5_table.cc