STORMM Source Documentation
Loading...
Searching...
No Matches
stormm::diskutil::BinaryFileContent Class Reference

Public Member Functions

void setLowerBound (llint lower_bound_in)
 Set the lower bound of memory for this content within a binary file.
 
void setUpperBound (llint upper_bound_in)
 Set the upper bound of memory for this content within a binary file.
 
template<typename T>
 BinaryFileContent (T content_in, bool repeating_in, const std::string description_in, HybridTargetLevel tier_in=HybridTargetLevel::HOST)
 The constructor requires the type of data, its length, some way to make a pointer to the data itself, and the description. The lower and upper bounds of the bytes for the actual content will be calculated and stored in the class object once the list of binary file content is compiled.
 
 BinaryFileContent (size_t ct_vptr_in, size_t length_in, const void *vptr_in, bool repeating_in, const std::string &description_in, HybridTargetLevel tier_in=HybridTargetLevel::HOST)
 

Constructor & Destructor Documentation

◆ BinaryFileContent()

template<typename T>
stormm::diskutil::BinaryFileContent::BinaryFileContent ( T content_in,
bool repeating_in,
const std::string description_in,
HybridTargetLevel tier_in = HybridTargetLevel::HOST )

The constructor requires the type of data, its length, some way to make a pointer to the data itself, and the description. The lower and upper bounds of the bytes for the actual content will be calculated and stored in the class object once the list of binary file content is compiled.

Overloaded:

  • Provide a scalar item for content, the type of which will be detected to translate into the type_code member variable
  • Provide a void-casted pointer to an array of data for content, the type of which must be indicated by a prior-generated hash code

Member Function Documentation

◆ setLowerBound()

void stormm::diskutil::BinaryFileContent::setLowerBound ( llint lower_bound_in)

Set the lower bound of memory for this content within a binary file.

Parameters
lower_bound_inThe lower bound of bytes for this data entry in the binary file

◆ setUpperBound()

void stormm::diskutil::BinaryFileContent::setUpperBound ( llint upper_bound_in)

Set the upper bound of memory for this content within a binary file.

Parameters
upper_bound_inThe upper bound of bytes for this data entry in the binary file

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