A record set for storing various poset attributes. More...

#include <attributes_record_set.h>

Inheritance diagram for sheaf::attributes_record_set:

Public Member Functions
	attributes_record_set (const attributes_record_set &xother)
	Copy constructor. More...

virtual attributes_record_set *	clone () const
	Virtual constructor; makes a new instance of the same type as this. More...

virtual	~attributes_record_set ()
	Destructor. More...

virtual bool	invariant () const
	Class invariant. More...

virtual bool	is_ancestor_of (const any *other) const
	Conformance test; true if other conforms to this. More...

	attributes_record_set (const sheaf_file &xfile, const poset_scaffold &xscaffold)
	Creates an instance attached to the record_set with name xname in the file xfile, with a record buffer containing xbuffer_ub records. More...

virtual const std::string &	suffix () const
	The name suffix for this data set. More...

void	internalize ()
	Internalize the record set from disk. More...

void	externalize ()
	Externalize the reccord set to disk. More...

Public Member Functions inherited from sheaf::record_set
	record_set (const sheaf_file &xfile, int xrecord_buffer_ub, const poset_scaffold &xscaffold)
	Creates an instance attached to the record_set with name xname in the file xfile, using record packets of size xpacket_ub. More...

	record_set (const record_set &xother)
	Copy constructor. More...

virtual	~record_set ()
	Destructor. More...

const sheaf_file &	file () const
	The file this record_set belongs to. More...

std::string	name () const
	The name of this data set. More...

std::string	alias () const
	The standard alias for this data set. More...

std::string	data_set_name (const std::string &xname) const
	The data set name for a poset with name xname. More...

std::string	data_set_alias (const std::string &xname) const
	The data set alias for a poset with name xname. More...

std::string	poset_name () const
	The name of the poset this represents, extracted from the name of the dataset. More...

poset_scaffold &	scaffold ()
	Scaffold for constructing poset associated with this record set (mutable version). More...

const poset_scaffold &	scaffold () const
	Scaffold for constructing poset associated with this record set (const version). More...

poset_data_type_map &	type_map ()
	Data type map for records in this record set (mutable version) More...

const poset_data_type_map &	type_map () const
	Data type map for records in this record set (const version) More...

virtual void	open ()
	Opens the record_set. More...

bool	is_open () const
	True if this record_set is open. More...

virtual void	close ()
	Closes the record_set. More...

int	record_buffer_ct () const
	The number of active records in record buffer. More...

void	inc_record_buffer_ct ()
	The increment the number of active records in record buffer. More...

void	reset_record_buffer_ct ()
	The set the number of active records in record buffer to 0. More...

int	record_buffer_ub () const
	The maximum number of records the buffer can hold. More...

bool	record_buffer_is_empty () const
	True if there are no active records in the buffer. More...

bool	record_buffer_is_full () const
	True if there are no inactive records in the buffer. More...

Public Member Functions inherited from sheaf::any
bool	is_same_type (const any *other) const
	True if other is the same type as this. More...

virtual	~any ()
	Destructor. More...

bool	invariant_check () const
	True if invariant checking is enabled. More...

void	enable_invariant_check () const
	Enable invariant checking. More...

void	disable_invariant_check () const
	Disable invariant check. Intended for preventing recursive calls to invariant and for suppressing invariant checking during multi-phase initialization. More...

int	disable_invariance_check_request_depth () const
	Number of times disable_invariant_check has been called without matching call to enable_invariant_check. More...

Protected Member Functions
virtual hid_t	create_dataset ()
	Creates the HDF dataset associated with this. More...

virtual void	create_int_data_type ()
	Creates a new HDF internal data type. More...

virtual void	read_dataset_attributes ()
	Reads the dataset attribute objects from the file. More...

virtual void	write_dataset_attributes ()
	Writes the dataset attribute objects into the file. More...

virtual void	read_toc_bounds_attribute ()
	Reads the table of contents lower bound attribute into the file. More...

virtual void	write_toc_bounds_attribute ()
	Writes the table of contents lower bound attribute into the file. More...

Protected Member Functions inherited from sheaf::record_set
void	extend_dataset (const hsize_t *xdims, int xdims_ub)
	Extends the dataset dimensions to at least the dimensions given xdims, an array of length xdims_ub. More...

void	create_alias ()
	Creates a soft link from alias to the data set. More...

void	set_name_from_alias ()
	Sets the primary name of the dataset from the alias. More...

hid_t	hdf_id ()
	The HDF id for this record set. More...

hid_t	ext_dataspace_hdf_id ()
	The HDF id for the external dataspace of this record set. More...

hid_t	ext_data_type_hdf_id ()
	The HDF external data type id for this record set. More...

int	ext_dataspace_rank ()
	The rank of the dataspace for the record_set. More...

hsize_t	ext_dataspace_dim (int xi)
	The dimension of xi-th index of the external dataspace. More...

hid_t	int_dataspace_hdf_id ()
	The hdf5 id of the internal dataspace associated with the record buffer. More...

hid_t	int_data_type_hdf_id ()
	The HDF internal data type id for this record set. More...

void	read_attribute (const char &xatt_values, size_type &xatt_ct, const data_converter xatt_conv, const std::string &xatt_name)
	Reads the attribute with name xatt_name from the file. More...

void	write_attribute (const void xatt_values, size_type xatt_ct, const data_converter xatt_conv, const std::string &xatt_name)
	Writes the attribute with name xatt_name into the file. More...

Protected Member Functions inherited from sheaf::any
	any ()
	default constructor More...

Static Protected Member Functions
static const char *	TOC_BOUNDS_ATTRIBUTE_NAME ()
	The name of the table of contents lower bound attribute. More...

Static Protected Attributes
static const hsize_t	TOC_BOUNDS_EXTENT = 3
	The extent of the table of contents lower bound attribute dataspace. More...

Static Protected Attributes inherited from sheaf::record_set
static const hid_t	NOT_AN_HDF_ID = -1
	Value indicating an invalid HDf object id. /. More...

Additional Inherited Members
Static Public Member Functions inherited from sheaf::record_set
static const std::string &	name_space_alias ()
	The reserved, standard alias for the namespace in the file. More...

static const std::string &	name_space_prefix ()
	The reserved, standard prefix for namespace dataser names. More...

Protected Attributes inherited from sheaf::record_set
sheaf_file &	_file
	The file this record_set belongs to. More...

std::string	_name
	The name of this record_set. More...

std::string	_alias
	The standard alias for this record_set. More...

poset_scaffold &	_scaffold
	The poset scaffold associated with this. More...

hid_t	_hdf_id
	The HDF id for this record set. More...

hid_t	_ext_dataspace_hdf_id
	The HDF id for the external dataspace of this record set. More...

hid_t	_ext_data_type_hdf_id
	The HDF external data type id for this record set. More...

int	_ext_dataspace_rank
	The rank of the dataspace for the record_set. More...

hsize_t *	_ext_dataspace_dims
	The current dimensions of the external dataspace. More...

int	_record_buffer_ct
	The number of active records in record buffer. More...

int	_record_buffer_ub
	The maximum number of records the buffer can hold. More...

hid_t	_int_dataspace_hdf_id
	The hdf5 id of the dataspace associated with the record buffer. More...

hid_t	_int_data_type_hdf_id
	The HDF internal data type id for this record set. More...

Detailed Description

A record set for storing various poset attributes.

Definition at line 85 of file attributes_record_set.h.

Constructor & Destructor Documentation

◆ attributes_record_set() [1/2]

sheaf::attributes_record_set::attributes_record_set ( const attributes_record_set & xother )

Copy constructor.

Not Implemented.

Postcondition

invariant()

Definition at line 56 of file attributes_record_set.cc.

References clone(), and invariant().

Referenced by clone(), and is_ancestor_of().

◆ ~attributes_record_set()

sheaf::attributes_record_set::~attributes_record_set ( )

virtual

Destructor.

Definition at line 112 of file attributes_record_set.cc.

References sheaf::record_set::_ext_dataspace_dims, and invariant().

Referenced by clone().

◆ attributes_record_set() [2/2]

sheaf::attributes_record_set::attributes_record_set	(	const sheaf_file &	xfile,
		const poset_scaffold &	xscaffold
	)

Creates an instance attached to the record_set with name xname in the file xfile, with a record buffer containing xbuffer_ub records.

Precondition

xfile.is_open()

!xscaffold.structure().name().empty()

Postcondition

invariant()

name() == data_set_name(scaffold().structure().name())

alias() == data_set_alias(scaffold().structure().name())

!is_open()

record_buffer_ub() == RECORD_BUFFER_UB

record_buffer_ct() == 0

Definition at line 193 of file attributes_record_set.cc.

Member Function Documentation

◆ clone()

sheaf::attributes_record_set * sheaf::attributes_record_set::clone ( ) const

virtual

Virtual constructor; makes a new instance of the same type as this.

Postcondition

result != 0

is_same_type(result)

Reimplemented from sheaf::record_set.

Definition at line 89 of file attributes_record_set.cc.

References attributes_record_set(), sheaf::any::is_same_type(), and ~attributes_record_set().

Referenced by attributes_record_set().

◆ create_dataset()

hid_t sheaf::attributes_record_set::create_dataset ( )

protectedvirtual

Creates the HDF dataset associated with this.

Precondition

file().mode() == sheaf_file::READ_WRITE

Postcondition

result >= 0

Implements sheaf::record_set.

Definition at line 506 of file attributes_record_set.cc.

References sheaf::record_set::_ext_dataspace_hdf_id, sheaf::record_set::_int_data_type_hdf_id, create_int_data_type(), sheaf::record_set::file(), sheaf::record_set::hdf_id(), sheaf::record_set::name(), and sheaf::record_set::record_buffer_ub().

Referenced by externalize().

◆ create_int_data_type()

void sheaf::attributes_record_set::create_int_data_type ( )

protectedvirtual

Creates a new HDF internal data type.

Precondition

file().is_open()

Hack:: the hdf type H5T_C_S1 with len set to H5T_VARIABLE hides the hdf variable length data type hvl_t, so this class doesn't quite fit the structure provided by base class variable_length_record. Make it work anyway.

Postcondition