H5std_string
for the buffer that provide the text description of the returned byte order. The text description can be either of the following: "Little endian byte ordering (0)"; "Big endian byte ordering (1)"; "VAX mixed byte ordering (2)";. int H5::AtomType::getOffset | ( | ) | const |
Retrieves the bit offset of the first significant bit.
H5::DataTypeIException |
References H5::IdComponent::inMemFunc().
H5T_order_t H5::AtomType::getOrder | ( | H5std_string & | order_string | ) | const |
This is an overloaded member function, provided for convenience. It takes a reference to a H5std_string
for the buffer that provide the text description of the returned byte order. The text description can be either of the following: "Little endian byte ordering (0)"; "Big endian byte ordering (1)"; "VAX mixed byte ordering (2)";.
order_string | - OUT: Text description of the returned byte order |
H5T_ORDER_LE
H5T_ORDER_BE
H5T_ORDER_VAX
H5::DataTypeIException |
References getOrder().
H5T_order_t H5::AtomType::getOrder | ( | ) | const |
Returns the byte order of an atomic datatype.
H5T_ORDER_LE
H5T_ORDER_BE
H5T_ORDER_VAX
H5::DataTypeIException |
References H5::IdComponent::inMemFunc().
Referenced by getOrder().
void H5::AtomType::getPad | ( | H5T_pad_t & | lsb, | |
H5T_pad_t & | msb | |||
) | const |
Retrieves the padding type of the least and most-significant bit padding.
lsb | - OUT: Least-significant bit padding type | |
msb | - OUT: Most-significant bit padding type |
H5::DataTypeIException |
H5T_PAD_ZERO
(0) - Set background to zeros. H5T_PAD_ONE
(1) - Set background to ones. H5T_PAD_BACKGROUND
(2) - Leave background alone. References H5::IdComponent::inMemFunc().
size_t H5::AtomType::getPrecision | ( | ) | const |
Returns the precision of an atomic datatype.
H5::DataTypeIException |
DataType::getSize()
. References H5::IdComponent::inMemFunc().
void H5::AtomType::setOffset | ( | size_t | offset | ) | const |
Sets the bit offset of the first significant bit.
offset | - IN: Offset of first significant bit |
H5::DataTypeIException |
References H5::IdComponent::inMemFunc().
void H5::AtomType::setOrder | ( | H5T_order_t | order | ) | const |
Sets the byte ordering of an atomic datatype.
order | - IN: Byte ordering constant, which can be:
|
H5::DataTypeIException |
References H5::IdComponent::inMemFunc().
void H5::AtomType::setPad | ( | H5T_pad_t | lsb, | |
H5T_pad_t | msb | |||
) | const |
Sets the least and most-significant bits padding types.
lsb | - IN: Least-significant bit padding type | |
msb | - IN: Most-significant bit padding type |
H5::DataTypeIException |
H5T_PAD_ZERO
(0) - Set background to zeros. H5T_PAD_ONE
(1) - Set background to ones. H5T_PAD_BACKGROUND
(2) - Leave background alone. References H5::IdComponent::inMemFunc().
void H5::AtomType::setPrecision | ( | size_t | precision | ) | const |
Sets the precision of an atomic datatype.
precision | - IN: Number of bits of precision |
H5::DataTypeIException |
References H5::IdComponent::inMemFunc().
void H5::AtomType::setSize | ( | size_t | size | ) | const |
Sets the total size for an atomic datatype.
size | - IN: Size to set |
H5::DataTypeIException |
References H5::IdComponent::inMemFunc().
Referenced by H5::StrType::StrType().