SheafSystem  0.0.0.0
sheaf::dof_tuple_schema_ids_record Class Reference

A wrapper/adapter for the dof tuple schema ids record. Intended for transferring index-id map data between the kernel and the i/o subsystem. More...

#include <dof_tuple_schema_ids_record.h>

Inheritance diagram for sheaf::dof_tuple_schema_ids_record:
sheaf::attributes_record sheaf::variable_length_record sheaf::record sheaf::any

Public Member Functions

virtual dof_tuple_schema_ids_recordclone () const
 Virtual constructor; makes a new instance of the same type as this. 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...
 
 dof_tuple_schema_ids_record (poset_scaffold &xscaffold)
 Creates an instance with type map xtype_map. More...
 
 dof_tuple_schema_ids_record (const dof_tuple_schema_ids_record &xother)
 Copy constructor. More...
 
virtual ~dof_tuple_schema_ids_record ()
 Destructor. More...
 
- Public Member Functions inherited from sheaf::attributes_record
 attributes_record (const attributes_record &xother)
 Copy constructor. More...
 
virtual ~attributes_record ()
 Destructor. More...
 
 attributes_record (poset_scaffold &xscaffold)
 Creates an instance with type map xtype_map. More...
 
void internalize (hdf_buf_type *xhdf_buffer)
 Converts the record from external to internal form. More...
 
void externalize (hdf_buf_type *xhdf_buffer)
 Converts the record from internal to external form. More...
 
- Public Member Functions inherited from sheaf::variable_length_record
 variable_length_record (const variable_length_record &xother)
 Copy constructor. More...
 
virtual ~variable_length_record ()
 Destructor. 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_scaffoldscaffold ()
 The scaffold for the poset associated with this record (mutable version). More...
 
const poset_scaffoldscaffold () const
 The scaffold for the poset associated with this record (const version). More...
 
poset_data_type_maptype_map ()
 The data type map used to convert data for this record (mutable version). More...
 
const poset_data_type_maptype_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 transfer_internal_buffer_to_poset ()
 Initializes the poset from the internal buffer. More...
 
void transfer_poset_to_internal_buffer ()
 Initializes the internal buffer from the poset. More...
 
- Protected Member Functions inherited from sheaf::attributes_record
void transfer_HDF_to_external_buffer (hdf_buf_type *xbuf)
 Initializes the external buffer from xbuf. More...
 
void transfer_external_buffer_to_HDF (hdf_buf_type *xbuf)
 Initializes the HDF buffer xbuf from the external buffer. More...
 
void convert_external_buffer_to_internal_buffer ()
 Converts the external buffer to internal form and places the result in the internal buffer. More...
 
void convert_internal_buffer_to_external_buffer ()
 Converts the internal buffer to external form and places the result in the external buffer. More...
 
- Protected Member Functions inherited from sheaf::variable_length_record
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...
 

Additional Inherited Members

- Public Types inherited from sheaf::attributes_record
typedef char * hdf_buf_type
 The type of hdf buffer. More...
 
- Protected Attributes inherited from sheaf::attributes_record
std::string _str_buf
 The internal/external buffer. More...
 

Detailed Description

A wrapper/adapter for the dof tuple schema ids record. Intended for transferring index-id map data between the kernel and the i/o subsystem.

Definition at line 40 of file dof_tuple_schema_ids_record.h.

Constructor & Destructor Documentation

◆ dof_tuple_schema_ids_record() [1/2]

sheaf::dof_tuple_schema_ids_record::dof_tuple_schema_ids_record ( poset_scaffold xscaffold)

Creates an instance with type map xtype_map.

Postcondition

Definition at line 117 of file dof_tuple_schema_ids_record.cc.

References invariant().

Referenced by is_ancestor_of().

◆ dof_tuple_schema_ids_record() [2/2]

sheaf::dof_tuple_schema_ids_record::dof_tuple_schema_ids_record ( const dof_tuple_schema_ids_record xother)

Copy constructor.

Not Implemented.

Postcondition

Definition at line 137 of file dof_tuple_schema_ids_record.cc.

References invariant(), and ~dof_tuple_schema_ids_record().

◆ ~dof_tuple_schema_ids_record()

sheaf::dof_tuple_schema_ids_record::~dof_tuple_schema_ids_record ( )
virtual

Destructor.

Issue:
can we just not define this function?

Definition at line 156 of file dof_tuple_schema_ids_record.cc.

References transfer_internal_buffer_to_poset().

Referenced by dof_tuple_schema_ids_record().

Member Function Documentation

◆ clone()

sheaf::dof_tuple_schema_ids_record * sheaf::dof_tuple_schema_ids_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::attributes_record.

Definition at line 34 of file dof_tuple_schema_ids_record.cc.

References invariant().

◆ invariant()

bool sheaf::dof_tuple_schema_ids_record::invariant ( ) const
virtual

Class invariant.

Reimplemented from sheaf::attributes_record.

Definition at line 58 of file dof_tuple_schema_ids_record.cc.

References is_ancestor_of().

Referenced by clone(), and dof_tuple_schema_ids_record().

◆ is_ancestor_of()

bool sheaf::dof_tuple_schema_ids_record::is_ancestor_of ( const any other) const
virtual

Conformance test; true if other conforms to this.

Precondition
  • other != 0

Reimplemented from sheaf::attributes_record.

Definition at line 91 of file dof_tuple_schema_ids_record.cc.

References dof_tuple_schema_ids_record().

Referenced by invariant().

◆ transfer_internal_buffer_to_poset()

void sheaf::dof_tuple_schema_ids_record::transfer_internal_buffer_to_poset ( )
protectedvirtual

◆ transfer_poset_to_internal_buffer()

void sheaf::dof_tuple_schema_ids_record::transfer_poset_to_internal_buffer ( )
protectedvirtual

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