sheaf::variable_length_record Class Reference

The general variable length record wrapper/adapter for transferring data between the kernel and the i/o subsystem. More...

#include <variable_length_record.h>

Inheritance diagram for sheaf::variable_length_record:

Public Member Functions
	variable_length_record (const variable_length_record &xother)
	Copy constructor. More...
virtual variable_length_record *	clone () const
	Virtual constructor; makes a new instance of the same type as this. More...
virtual	~variable_length_record ()
	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...
	variable_length_record (const poset_scaffold &xscaffold)
	Creates an instance with type map xtype_map. More...
void *	buf () const
	The buffer. More...
size_t	buf_ub () const
	The size of the buffer, in bytes. More...
Public Member Functions inherited from sheaf::record
	record (const record &xother)
	Copy constructor. More...
virtual	~record ()
	Destructor. More...
	record (const poset_scaffold &xscaffold)
	Creates an instance with type map xtype_map. More...
record_index	external_index () const
	The external index of this record. More...
void	put_external_index (const record_index &xindex)
	Sets the index of this record to xindex. More...
poset_scaffold &	scaffold ()
	The scaffold for the poset associated with this record (mutable version). More...
const poset_scaffold &	scaffold () const
	The scaffold for the poset associated with this record (const version). More...
poset_data_type_map &	type_map ()
	The data type map used to convert data for this record (mutable version). More...
const poset_data_type_map &	type_map () const
	The data type map used to convert data for this record (const version). 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
void	put_buf (const void *xbuf, size_t xub)
	Sets the buffer to xbuf. More...
bool	delete_buffer ()
	True if this allocated the buffer and the dtor should delete it. More...
void	put_delete_buffer (bool xval)
	Sets delete_buffer to value xval. More...
void *	item (size_t xoffset) const
	Pointer to record item beginning at offset xoffset. More...
bool	is_internal () const
	True if the internal buffer has been initialized. More...
void	put_is_internal (bool xis_internal)
	Sets is_internal to xis_internal. More...
bool	is_external () const
	True if the external buffer has been initialized. More...
void	put_is_external (bool xis_external)
	Sets is_external to xis_external. More...
Protected Member Functions inherited from sheaf::any
	any ()
	default constructor More...

Detailed Description

The general variable length record wrapper/adapter for transferring data between the kernel and the i/o subsystem.

Definition at line 39 of file variable_length_record.h.

Constructor & Destructor Documentation

variable_length_record() [1/2]

sheaf::variable_length_record::variable_length_record

(

const variable_length_record &

xother

)

Copy constructor.

Not Implemented.

Postcondition

• invariant()

Definition at line 32 of file variable_length_record.cc.

References clone(), and invariant().

Referenced by clone(), and is_ancestor_of().

~variable_length_record()

sheaf::variable_length_record::~variable_length_record ( )

virtual

Destructor.

Definition at line 80 of file variable_length_record.cc.

References invariant().

Referenced by clone().

variable_length_record() [2/2]

sheaf::variable_length_record::variable_length_record

(

const poset_scaffold &

xscaffold

)

Creates an instance with type map xtype_map.

Postcondition

• invariant()

• !external_index().is_valid()

• &(scaffold()) == &xscaffold

• buf() == 0

• buf_ub() == 0

• !delete_buffer()

• !is_internal()

• !is_external()

Definition at line 166 of file variable_length_record.cc.

References buf(), buf_ub(), delete_buffer(), sheaf::record::external_index(), invariant(), is_external(), is_internal(), sheaf::is_valid(), and sheaf::record::scaffold().

Member Function Documentation

buf()

void * sheaf::variable_length_record::buf

(

)

const

The buffer.

Definition at line 201 of file variable_length_record.cc.

References buf_ub().

Referenced by sheaf::attributes_record::convert_external_buffer_to_internal_buffer(), sheaf::interval_index_space_record::externalize(), sheaf::map_record::externalize(), sheaf::member_record::externalize(), sheaf::map_record::internalize(), sheaf::interval_index_space_record::internalize(), sheaf::member_record::internalize(), sheaf::interval_index_space_record::interval_index_space_record(), sheaf::map_record::map_record(), sheaf::member_record::member_record(), put_buf(), sheaf::attributes_record::transfer_external_buffer_to_HDF(), sheaf::attributes_record::transfer_HDF_to_external_buffer(), and variable_length_record().

buf_ub()

size_t sheaf::variable_length_record::buf_ub

(

)

const

The size of the buffer, in bytes.

Definition at line 223 of file variable_length_record.cc.

References put_buf().

Referenced by buf(), sheaf::attributes_record::convert_external_buffer_to_internal_buffer(), sheaf::interval_index_space_record::externalize(), sheaf::map_record::externalize(), sheaf::member_record::externalize(), sheaf::map_record::internalize(), sheaf::interval_index_space_record::internalize(), sheaf::member_record::internalize(), sheaf::interval_index_space_record::interval_index_space_record(), sheaf::map_record::map_record(), sheaf::member_record::member_record(), put_buf(), sheaf::attributes_record::transfer_HDF_to_external_buffer(), and variable_length_record().

clone()

sheaf::variable_length_record * sheaf::variable_length_record::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.

Reimplemented in sheaf::member_record, sheaf::interval_index_space_record, sheaf::map_record, sheaf::poset_general_record, sheaf::attributes_record, sheaf::member_names_record, sheaf::dof_tuple_class_names_record, sheaf::dof_tuple_col_bounds_record, sheaf::dof_tuple_domain_offsets_record, sheaf::dof_tuple_schema_ids_record, sheaf::dof_tuple_schema_versions_record, sheaf::dof_tuple_types_record, sheaf::member_class_names_record, sheaf::id_space_names_record, sheaf::subposet_names_record, and sheaf::table_dof_tuple_record.

Definition at line 56 of file variable_length_record.cc.

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

Referenced by variable_length_record().

delete_buffer()

bool sheaf::variable_length_record::delete_buffer ( )

inlineprotected

True if this allocated the buffer and the dtor should delete it.

Definition at line 105 of file variable_length_record.h.

Referenced by variable_length_record().

invariant()

bool sheaf::variable_length_record::invariant ( ) const

virtual

Class invariant.

Reimplemented from sheaf::record.

Reimplemented in sheaf::member_record, sheaf::interval_index_space_record, sheaf::map_record, sheaf::poset_general_record, sheaf::attributes_record, sheaf::member_names_record, sheaf::dof_tuple_class_names_record, sheaf::dof_tuple_col_bounds_record, sheaf::dof_tuple_domain_offsets_record, sheaf::dof_tuple_schema_ids_record, sheaf::dof_tuple_schema_versions_record, sheaf::dof_tuple_types_record, sheaf::member_class_names_record, sheaf::id_space_names_record, sheaf::subposet_names_record, and sheaf::table_dof_tuple_record.

Definition at line 105 of file variable_length_record.cc.

References sheaf::any::disable_invariant_check(), sheaf::any::enable_invariant_check(), sheaf::record::invariant(), sheaf::any::invariant_check(), and is_ancestor_of().

Referenced by sheaf::attributes_record::invariant(), sheaf::interval_index_space_record::invariant(), sheaf::map_record::invariant(), sheaf::member_record::invariant(), variable_length_record(), and ~variable_length_record().

is_ancestor_of()

bool sheaf::variable_length_record::is_ancestor_of ( const any *  other ) const

virtual

Conformance test; true if other conforms to this.

Precondition

• other != 0

Reimplemented from sheaf::record.

Reimplemented in sheaf::member_record, sheaf::interval_index_space_record, sheaf::map_record, sheaf::poset_general_record, sheaf::attributes_record, sheaf::member_names_record, sheaf::dof_tuple_class_names_record, sheaf::dof_tuple_col_bounds_record, sheaf::dof_tuple_domain_offsets_record, sheaf::dof_tuple_schema_ids_record, sheaf::dof_tuple_schema_versions_record, sheaf::dof_tuple_types_record, sheaf::member_class_names_record, sheaf::id_space_names_record, sheaf::subposet_names_record, and sheaf::table_dof_tuple_record.

Definition at line 139 of file variable_length_record.cc.

References variable_length_record().

Referenced by invariant().

is_external()

bool sheaf::variable_length_record::is_external ( ) const

inlineprotected

True if the external buffer has been initialized.

Definition at line 151 of file variable_length_record.h.

Referenced by sheaf::attributes_record::convert_external_buffer_to_internal_buffer(), sheaf::attributes_record::convert_internal_buffer_to_external_buffer(), sheaf::interval_index_space_record::externalize(), sheaf::map_record::externalize(), sheaf::attributes_record::externalize(), sheaf::member_record::externalize(), sheaf::attributes_record::internalize(), sheaf::interval_index_space_record::internalize(), sheaf::map_record::internalize(), sheaf::member_record::internalize(), sheaf::interval_index_space_record::interval_index_space_record(), sheaf::map_record::map_record(), sheaf::member_record::member_record(), sheaf::attributes_record::transfer_external_buffer_to_HDF(), sheaf::attributes_record::transfer_HDF_to_external_buffer(), sheaf::table_dof_tuple_record::transfer_internal_buffer_to_poset(), sheaf::poset_general_record::transfer_internal_buffer_to_poset(), sheaf::attributes_record::transfer_internal_buffer_to_poset(), sheaf::table_dof_tuple_record::transfer_poset_to_internal_buffer(), sheaf::id_space_names_record::transfer_poset_to_internal_buffer(), sheaf::subposet_names_record::transfer_poset_to_internal_buffer(), sheaf::dof_tuple_types_record::transfer_poset_to_internal_buffer(), sheaf::dof_tuple_domain_offsets_record::transfer_poset_to_internal_buffer(), sheaf::member_class_names_record::transfer_poset_to_internal_buffer(), sheaf::dof_tuple_col_bounds_record::transfer_poset_to_internal_buffer(), sheaf::dof_tuple_class_names_record::transfer_poset_to_internal_buffer(), sheaf::dof_tuple_schema_versions_record::transfer_poset_to_internal_buffer(), sheaf::dof_tuple_schema_ids_record::transfer_poset_to_internal_buffer(), sheaf::member_names_record::transfer_poset_to_internal_buffer(), sheaf::poset_general_record::transfer_poset_to_internal_buffer(), sheaf::attributes_record::transfer_poset_to_internal_buffer(), and variable_length_record().

is_internal()

bool sheaf::variable_length_record::is_internal ( ) const

inlineprotected

True if the internal buffer has been initialized.

Definition at line 133 of file variable_length_record.h.

Referenced by sheaf::attributes_record::convert_external_buffer_to_internal_buffer(), sheaf::attributes_record::convert_internal_buffer_to_external_buffer(), sheaf::interval_index_space_record::externalize(), sheaf::map_record::externalize(), sheaf::member_record::externalize(), sheaf::attributes_record::internalize(), sheaf::interval_index_space_record::internalize(), sheaf::map_record::internalize(), sheaf::member_record::internalize(), sheaf::interval_index_space_record::interval_index_space_record(), sheaf::map_record::map_record(), sheaf::member_record::member_record(), sheaf::attributes_record::transfer_HDF_to_external_buffer(), sheaf::id_space_names_record::transfer_internal_buffer_to_poset(), sheaf::subposet_names_record::transfer_internal_buffer_to_poset(), sheaf::dof_tuple_types_record::transfer_internal_buffer_to_poset(), sheaf::dof_tuple_col_bounds_record::transfer_internal_buffer_to_poset(), sheaf::dof_tuple_schema_versions_record::transfer_internal_buffer_to_poset(), sheaf::dof_tuple_domain_offsets_record::transfer_internal_buffer_to_poset(), sheaf::dof_tuple_schema_ids_record::transfer_internal_buffer_to_poset(), sheaf::member_class_names_record::transfer_internal_buffer_to_poset(), sheaf::dof_tuple_class_names_record::transfer_internal_buffer_to_poset(), sheaf::member_names_record::transfer_internal_buffer_to_poset(), sheaf::poset_general_record::transfer_internal_buffer_to_poset(), sheaf::attributes_record::transfer_internal_buffer_to_poset(), sheaf::table_dof_tuple_record::transfer_poset_to_internal_buffer(), sheaf::id_space_names_record::transfer_poset_to_internal_buffer(), sheaf::subposet_names_record::transfer_poset_to_internal_buffer(), sheaf::dof_tuple_col_bounds_record::transfer_poset_to_internal_buffer(), sheaf::dof_tuple_domain_offsets_record::transfer_poset_to_internal_buffer(), sheaf::dof_tuple_class_names_record::transfer_poset_to_internal_buffer(), sheaf::dof_tuple_schema_versions_record::transfer_poset_to_internal_buffer(), sheaf::member_class_names_record::transfer_poset_to_internal_buffer(), sheaf::dof_tuple_types_record::transfer_poset_to_internal_buffer(), sheaf::dof_tuple_schema_ids_record::transfer_poset_to_internal_buffer(), sheaf::member_names_record::transfer_poset_to_internal_buffer(), sheaf::poset_general_record::transfer_poset_to_internal_buffer(), sheaf::attributes_record::transfer_poset_to_internal_buffer(), and variable_length_record().

item()

void* sheaf::variable_length_record::item ( size_t  xoffset ) const

inlineprotected

Pointer to record item beginning at offset xoffset.

Definition at line 123 of file variable_length_record.h.

put_buf()

void sheaf::variable_length_record::put_buf ( const void *  xbuf, size_t  xub  )

protected

Sets the buffer to xbuf.

Precondition

• (xbuf == 0) == (xbuf_ub == 0)

• -unexecutable( xuf_ub == allocated size of xbuf )

Postcondition

• buf() == xbuf

• buf_ub() == xbuf_ub

Definition at line 243 of file variable_length_record.cc.

References buf(), and buf_ub().

Referenced by buf_ub(), sheaf::attributes_record::convert_internal_buffer_to_external_buffer(), sheaf::map_record::externalize(), sheaf::interval_index_space_record::externalize(), sheaf::member_record::externalize(), sheaf::interval_index_space_record::internalize(), sheaf::map_record::internalize(), sheaf::member_record::internalize(), and sheaf::attributes_record::transfer_HDF_to_external_buffer().

put_delete_buffer()

void sheaf::variable_length_record::put_delete_buffer ( bool  xval )

inlineprotected

Sets delete_buffer to value xval.

Definition at line 113 of file variable_length_record.h.

Referenced by sheaf::attributes_record::convert_internal_buffer_to_external_buffer(), sheaf::interval_index_space_record::externalize(), sheaf::map_record::externalize(), and sheaf::member_record::externalize().

put_is_external()

void sheaf::variable_length_record::put_is_external ( bool  xis_external )

inlineprotected

Sets is_external to xis_external.

Definition at line 159 of file variable_length_record.h.

Referenced by sheaf::attributes_record::convert_internal_buffer_to_external_buffer(), sheaf::interval_index_space_record::externalize(), sheaf::map_record::externalize(), sheaf::member_record::externalize(), sheaf::interval_index_space_record::internalize(), sheaf::map_record::internalize(), sheaf::member_record::internalize(), sheaf::interval_index_space_record::interval_index_space_record(), sheaf::map_record::map_record(), sheaf::member_record::member_record(), sheaf::attributes_record::transfer_HDF_to_external_buffer(), sheaf::table_dof_tuple_record::transfer_poset_to_internal_buffer(), sheaf::id_space_names_record::transfer_poset_to_internal_buffer(), sheaf::subposet_names_record::transfer_poset_to_internal_buffer(), sheaf::dof_tuple_class_names_record::transfer_poset_to_internal_buffer(), sheaf::dof_tuple_schema_versions_record::transfer_poset_to_internal_buffer(), sheaf::dof_tuple_types_record::transfer_poset_to_internal_buffer(), sheaf::dof_tuple_schema_ids_record::transfer_poset_to_internal_buffer(), sheaf::member_class_names_record::transfer_poset_to_internal_buffer(), sheaf::dof_tuple_domain_offsets_record::transfer_poset_to_internal_buffer(), sheaf::dof_tuple_col_bounds_record::transfer_poset_to_internal_buffer(), sheaf::member_names_record::transfer_poset_to_internal_buffer(), and sheaf::poset_general_record::transfer_poset_to_internal_buffer().

put_is_internal()

void sheaf::variable_length_record::put_is_internal ( bool  xis_internal )

inlineprotected

Sets is_internal to xis_internal.

Definition at line 141 of file variable_length_record.h.

Referenced by sheaf::attributes_record::convert_external_buffer_to_internal_buffer(), sheaf::interval_index_space_record::externalize(), sheaf::map_record::externalize(), sheaf::member_record::externalize(), sheaf::interval_index_space_record::internalize(), sheaf::map_record::internalize(), sheaf::member_record::internalize(), sheaf::interval_index_space_record::interval_index_space_record(), sheaf::map_record::map_record(), sheaf::member_record::member_record(), sheaf::attributes_record::transfer_HDF_to_external_buffer(), sheaf::table_dof_tuple_record::transfer_poset_to_internal_buffer(), sheaf::id_space_names_record::transfer_poset_to_internal_buffer(), sheaf::subposet_names_record::transfer_poset_to_internal_buffer(), sheaf::dof_tuple_class_names_record::transfer_poset_to_internal_buffer(), sheaf::dof_tuple_schema_versions_record::transfer_poset_to_internal_buffer(), sheaf::dof_tuple_types_record::transfer_poset_to_internal_buffer(), sheaf::dof_tuple_schema_ids_record::transfer_poset_to_internal_buffer(), sheaf::member_class_names_record::transfer_poset_to_internal_buffer(), sheaf::dof_tuple_domain_offsets_record::transfer_poset_to_internal_buffer(), sheaf::dof_tuple_col_bounds_record::transfer_poset_to_internal_buffer(), sheaf::member_names_record::transfer_poset_to_internal_buffer(), and sheaf::poset_general_record::transfer_poset_to_internal_buffer().

---

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

• variable_length_record.h
• variable_length_record.cc