HDF5 C++ API  1.8.12
 All Classes Namespaces Files Functions Variables Typedefs Macros Pages
Public Member Functions | List of all members
H5::StrType Class Reference

Class StrType operates on HDF5 string datatypes. More...

#include <H5StrType.h>

Inheritance diagram for H5::StrType:
H5::AtomType H5::DataType H5::H5Object H5::H5Location H5::IdComponent

Public Member Functions

 StrType (const PredType &pred_type)
 Creates a string datatype using a predefined type. More...
 
 StrType (const PredType &pred_type, const size_t &size)
 Creates a string datatype with a specified length. More...
 
 StrType (const int dummy, const size_t &size)
 Creates a string datatype with a specified length. More...
 
 StrType (const DataSet &dataset)
 Gets the string datatype of the specified dataset. More...
 
H5T_cset_t getCset () const
 Retrieves the character set type of this string datatype. More...
 
void setCset (H5T_cset_t cset) const
 Sets character set to be used. More...
 
H5T_str_t getStrpad () const
 Retrieves the storage mechanism for of this string datatype. More...
 
void setStrpad (H5T_str_t strpad) const
 Defines the storage mechanism for this string datatype. More...
 
virtual H5std_string fromClass () const
 Returns this class name. More...
 
 StrType ()
 Default constructor: Creates a stub string datatype. More...
 
 StrType (const hid_t existing_id)
 Creates an StrType object using the id of an existing datatype. More...
 
 StrType (const StrType &original)
 Copy constructor: makes a copy of the original StrType object. More...
 
virtual ~StrType ()
 Properly terminates access to this string datatype. More...
 
- Public Member Functions inherited from H5::AtomType
H5T_order_t getOrder () const
 Returns the byte order of an atomic datatype. More...
 
H5T_order_t 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)";. More...
 
void setOrder (H5T_order_t order) const
 Sets the byte ordering of an atomic datatype. More...
 
int getOffset () const
 Retrieves the bit offset of the first significant bit. More...
 
void setOffset (size_t offset) const
 Sets the bit offset of the first significant bit. More...
 
void getPad (H5T_pad_t &lsb, H5T_pad_t &msb) const
 Retrieves the padding type of the least and most-significant bit padding. More...
 
void setPad (H5T_pad_t lsb, H5T_pad_t msb) const
 Sets the least and most-significant bits padding types. More...
 
size_t getPrecision () const
 Returns the precision of an atomic datatype. More...
 
void setPrecision (size_t precision) const
 Sets the precision of an atomic datatype. More...
 
void setSize (size_t size) const
 Sets the total size for an atomic datatype. More...
 
 AtomType (const AtomType &original)
 Copy constructor: makes a copy of the original AtomType object. More...
 
virtual ~AtomType ()
 Noop destructor. More...
 
- Public Member Functions inherited from H5::DataType
 DataType (const H5T_class_t type_class, size_t size)
 Creates a object given its class and size. More...
 
 DataType (const DataType &original)
 Copy constructor: makes a copy of the original DataType object. More...
 
 DataType (const H5Location &loc, const void *ref, H5R_type_t ref_type=H5R_OBJECT)
 Given a reference, ref, to an hdf5 group, creates a DataType object. More...
 
 DataType (const Attribute &attr, const void *ref, H5R_type_t ref_type=H5R_OBJECT)
 Given a reference, ref, to an hdf5 group, creates a DataType object. More...
 
virtual void close ()
 Closes the datatype if it is not a predefined type. More...
 
void copy (const DataType &like_type)
 Copies an existing datatype to this datatype object. More...
 
void copy (const DataSet &dset)
 Copies the datatype of the given dataset to this datatype object. More...
 
H5T_class_t getClass () const
 Returns the datatype class identifier. More...
 
void commit (H5Location &loc, const char *name)
 Commits a transient datatype to a file, creating a new named datatype. More...
 
void commit (H5Location &loc, const H5std_string &name)
 This is an overloaded member function, provided for convenience. It differs from the above function only in the type of the argument name. More...
 
bool committed () const
 Determines whether a datatype is a named type or a transient type. More...
 
H5T_conv_t find (const DataType &dest, H5T_cdata_t **pcdata) const
 Finds a conversion function that can handle a conversion from this datatype to the specified datatype, dest. More...
 
void convert (const DataType &dest, size_t nelmts, void *buf, void *background, const PropList &plist=PropList::DEFAULT) const
 Converts data from this datatype to the specified datatypes. More...
 
DataTypeoperator= (const DataType &rhs)
 Assignment operator. More...
 
bool operator== (const DataType &compared_type) const
 Compares this DataType against the given one to determines whether the two objects refer to the same actual datatype. More...
 
void lock () const
 Locks a datatype, making it read-only and non-destructible. More...
 
size_t getSize () const
 Returns the size of a datatype. More...
 
DataType getSuper () const
 Returns the base datatype from which a datatype is derived. More...
 
void registerFunc (H5T_pers_t pers, const char *name, const DataType &dest, H5T_conv_t func) const
 Registers the specified conversion function. More...
 
void registerFunc (H5T_pers_t pers, const H5std_string &name, const DataType &dest, H5T_conv_t func) const
 This is an overloaded member function, provided for convenience. It differs from the above function only in the type of the argument name. More...
 
void unregister (H5T_pers_t pers, const char *name, const DataType &dest, H5T_conv_t func) const
 Removes a conversion function from all conversion paths. More...
 
void unregister (H5T_pers_t pers, const H5std_string &name, const DataType &dest, H5T_conv_t func) const
 This is an overloaded member function, provided for convenience. It differs from the above function only in the type of the argument name. More...
 
void setTag (const char *tag) const
 Tags an opaque datatype. More...
 
void setTag (const H5std_string &tag) const
 This is an overloaded member function, provided for convenience. It differs from the above function only in the type of the argument name. More...
 
H5std_string getTag () const
 Gets the tag associated with an opaque datatype. More...
 
bool detectClass (H5T_class_t cls) const
 Checks whether a datatype contains (or is) a certain type of datatype. More...
 
bool isVariableStr () const
 Check whether this datatype is a variable-length string. More...
 
 DataType (const hid_t type_id)
 Creates a datatype using an existing datatype's id. More...
 
 DataType ()
 Default constructor: Creates a stub datatype. More...
 
virtual hid_t getId () const
 Get the id of this datatype. More...
 
virtual ~DataType ()
 Properly terminates access to this datatype. More...
 
- Public Member Functions inherited from H5::H5Object
 H5Object (const H5Object &original)
 Copy constructor: makes a copy of the original H5Object instance. More...
 
virtual ~H5Object ()
 Noop destructor. More...
 
- Public Member Functions inherited from H5::H5Location
Attribute createAttribute (const char *name, const DataType &type, const DataSpace &space, const PropList &create_plist=PropList::DEFAULT) const
 Creates an attribute for a group, dataset, or named datatype. More...
 
Attribute createAttribute (const H5std_string &name, const DataType &type, const DataSpace &space, const PropList &create_plist=PropList::DEFAULT) const
 This is an overloaded member function, provided for convenience. It differs from the above function in that it takes a reference to an H5std_string for name. More...
 
Attribute openAttribute (const char *name) const
 Opens an attribute given its name. More...
 
Attribute openAttribute (const H5std_string &name) const
 This is an overloaded member function, provided for convenience. It differs from the above function in that it takes a reference to an H5std_string for name. More...
 
Attribute openAttribute (const unsigned int idx) const
 Opens an attribute given its index. More...
 
void flush (H5F_scope_t scope) const
 Flushes all buffers associated with a location to disk. More...
 
H5std_string getFileName () const
 Gets the name of the file, in which this HDF5 object belongs. More...
 
int getNumAttrs () const
 Returns the number of attributes attached to this HDF5 object. More...
 
H5G_obj_t getObjType (void *ref, H5R_type_t ref_type=H5R_OBJECT) const
 Retrieves the type of object that an object reference points to. More...
 
H5O_type_t getRefObjType (void *ref, H5R_type_t ref_type=H5R_OBJECT) const
 Retrieves the type of object that an object reference points to. More...
 
int iterateAttrs (attr_operator_t user_op, unsigned *idx=NULL, void *op_data=NULL)
 Iterates a user's function over all the attributes of an H5 object, which may be a group, dataset or named datatype. More...
 
bool attrExists (const char *name) const
 Checks whether the named attribute exists at this location. More...
 
bool attrExists (const H5std_string &name) const
 This is an overloaded member function, provided for convenience. It differs from the above function in that it takes a reference to an H5std_string for name. More...
 
void renameAttr (const char *oldname, const char *newname) const
 Renames the named attribute from this object. More...
 
void renameAttr (const H5std_string &oldname, const H5std_string &newname) const
 This is an overloaded member function, provided for convenience. It differs from the above function in that it takes a reference to an H5std_string for the names. More...
 
void removeAttr (const char *name) const
 Removes the named attribute from this object. More...
 
void removeAttr (const H5std_string &name) const
 This is an overloaded member function, provided for convenience. It differs from the above function in that it takes a reference to an H5std_string for name. More...
 
void setComment (const char *name, const char *comment) const
 Sets or resets the comment for an object specified by its name. More...
 
void setComment (const H5std_string &name, const H5std_string &comment) const
 This is an overloaded member function, provided for convenience. It differs from the above function in that it takes an H5std_string for name and comment. More...
 
void setComment (const char *comment) const
 This is an overloaded member function, provided for convenience. It differs from the above function in that it doesn't take an object name. More...
 
void setComment (const H5std_string &comment) const
 This is an overloaded member function, provided for convenience. It differs from the above function in that it takes an H5std_string for comment. More...
 
H5std_string getComment (const char *name, size_t bufsize=256) const
 Retrieves comment for the specified object and its comment's length. More...
 
H5std_string getComment (const H5std_string &name, size_t bufsize=256) const
 This is an overloaded member function, provided for convenience. It differs from the above function in that it takes an H5std_string for name. More...
 
void removeComment (const char *name) const
 Removes the comment from an object specified by its name. More...
 
void removeComment (const H5std_string &name) const
 This is an overloaded member function, provided for convenience. It differs from the above function in that it takes an H5std_string for name. More...
 
void reference (void *ref, const char *name, H5R_type_t ref_type=H5R_OBJECT) const
 This is an overloaded function, provided for your convenience. It differs from the above function in that it does not take a DataSpace object and the reference type must be specified. More...
 
void reference (void *ref, const H5std_string &name, H5R_type_t ref_type=H5R_OBJECT) const
 This is an overloaded function, provided for your convenience. It differs from the above function in that it takes an H5std_string for the object's name. More...
 
void reference (void *ref, const char *name, const DataSpace &dataspace, H5R_type_t ref_type=H5R_DATASET_REGION) const
 Creates a reference to an HDF5 object or a dataset region. More...
 
void reference (void *ref, const H5std_string &name, const DataSpace &dataspace, H5R_type_t ref_type=H5R_DATASET_REGION) const
 This is an overloaded member function, provided for convenience. It differs from the above function in that it takes an H5std_string for name. More...
 
void dereference (const H5Location &loc, const void *ref, H5R_type_t ref_type=H5R_OBJECT)
 Dereferences a reference into an HDF5 object, given an HDF5 object. More...
 
void dereference (const Attribute &attr, const void *ref, H5R_type_t ref_type=H5R_OBJECT)
 Dereferences a reference into an HDF5 object, given an attribute. More...
 
DataSpace getRegion (void *ref, H5R_type_t ref_type=H5R_DATASET_REGION) const
 Retrieves a dataspace with the region pointed to selected. More...
 
- Public Member Functions inherited from H5::IdComponent
void incRefCount (const hid_t obj_id) const
 Increment reference counter for a given id. More...
 
void incRefCount () const
 Increment reference counter for the id of this object. More...
 
void decRefCount (const hid_t obj_id) const
 Decrement reference counter for a given id. More...
 
void decRefCount () const
 Decrement reference counter for the id of this object. More...
 
int getCounter (const hid_t obj_id) const
 Returns the reference counter for a given id. More...
 
int getCounter () const
 Returns the reference counter for the id of this object. More...
 
IdComponentoperator= (const IdComponent &rhs)
 Assignment operator. More...
 
void setId (const hid_t new_id)
 Sets the identifier of this object to a new value. More...
 
 IdComponent (const hid_t h5_id)
 Creates an IdComponent object using the id of an existing object. More...
 
 IdComponent (const IdComponent &original)
 Copy constructor: makes a copy of the original IdComponent object. More...
 
H5std_string inMemFunc (const char *func_name) const
 Makes and returns string "<class-name>::<func_name>". More...
 
virtual ~IdComponent ()
 Noop destructor. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from H5::IdComponent
static H5I_type_t getHDFObjType (const hid_t obj_id)
 Given an id, returns the type of the object. More...
 
- Protected Member Functions inherited from H5::AtomType
 AtomType ()
 
 AtomType (const hid_t existing_id)
 
- Protected Member Functions inherited from H5::DataType
virtual void p_setId (const hid_t new_id)
 Sets the identifier of this object to a new value. More...
 
- Protected Member Functions inherited from H5::H5Object
 H5Object ()
 
 H5Object (const hid_t object_id)
 
- Protected Member Functions inherited from H5::H5Location
 H5Location ()
 
 H5Location (const hid_t loc_id)
 
 H5Location (const H5Location &original)
 Copy constructor: makes a copy of the original H5Location instance. More...
 
void p_reference (void *ref, const char *name, hid_t space_id, H5R_type_t ref_type) const
 
hid_t p_dereference (hid_t loc_id, const void *ref, H5R_type_t ref_type, const char *from_func)
 
H5G_obj_t p_get_obj_type (void *ref, H5R_type_t ref_type) const
 
H5O_type_t p_get_ref_obj_type (void *ref, H5R_type_t ref_type) const
 
virtual ~H5Location ()
 Noop destructor. More...
 
- Protected Member Functions inherited from H5::IdComponent
 IdComponent ()
 Default constructor. More...
 
H5std_string p_get_file_name () const
 
- Static Protected Member Functions inherited from H5::IdComponent
static bool p_valid_id (const hid_t obj_id)
 
- Protected Attributes inherited from H5::DataType
hid_t id
 

Detailed Description

Class StrType operates on HDF5 string datatypes.

Constructor & Destructor Documentation

H5::StrType::StrType ( const PredType pred_type)

Creates a string datatype using a predefined type.

Parameters
pred_type- IN: Predefined datatype
Exceptions
H5::DataTypeIException
H5::StrType::StrType ( const PredType pred_type,
const size_t &  size 
)

Creates a string datatype with a specified length.

Parameters
pred_type- IN: String predefined type to replicate.
size- IN: Length of the new string type
Exceptions
H5::DataTypeIException
Note
The use of this constructor can be shortened by using its overloaded below as StrType(0, size).
H5::StrType::StrType ( const int  dummy,
const size_t &  size 
)

Creates a string datatype with a specified length.

Parameters
dummy- IN: To simplify calling the previous constructor and avoid prototype clash with another constructor
size- IN: Length of the new string type
Exceptions
H5::DataTypeIException
Description
The 1st argument is just a dummy to simplify calling the previous constructor, such as: StrType atype(0, size) instead of StrType atype(PredType::C_S1, size)
Note
This constructor may replace the previous one in the future.
H5::StrType::StrType ( const DataSet dataset)

Gets the string datatype of the specified dataset.

Parameters
dataset- IN: Dataset that this string datatype associates with
Exceptions
H5::DataTypeIException
H5::StrType::StrType ( )

Default constructor: Creates a stub string datatype.

H5::StrType::StrType ( const hid_t  existing_id)

Creates an StrType object using the id of an existing datatype.

Parameters
existing_id- IN: Id of an existing datatype
Exceptions
H5::DataTypeIException
H5::StrType::StrType ( const StrType original)

Copy constructor: makes a copy of the original StrType object.

H5::StrType::~StrType ( )
virtual

Properly terminates access to this string datatype.

Member Function Documentation

virtual H5std_string H5::StrType::fromClass ( ) const
inlinevirtual

Returns this class name.

Reimplemented from H5::AtomType.

H5T_cset_t H5::StrType::getCset ( ) const

Retrieves the character set type of this string datatype.

Returns
Character set type, which can be:
  • H5T_CSET_ASCII (0) - Character set is US ASCII.
Exceptions
H5::DataTypeIException
H5T_str_t H5::StrType::getStrpad ( ) const

Retrieves the storage mechanism for of this string datatype.

Returns
String storage mechanism, which can be:
  • H5T_STR_NULLTERM (0) - Null terminate (as C does)
  • H5T_STR_NULLPAD (0) - Pad with zeros
  • H5T_STR_SPACEPAD (0) - pad with spaces (as FORTRAN does)
Exceptions
H5::DataTypeIException
void H5::StrType::setCset ( H5T_cset_t  cset) const

Sets character set to be used.

Parameters
cset- IN: character set type, which can be:
  • H5T_CSET_ASCII (0) - Character set is US ASCII.
Exceptions
H5::DataTypeIException
void H5::StrType::setStrpad ( H5T_str_t  strpad) const

Defines the storage mechanism for this string datatype.

Parameters
strpad- IN: String padding type
Exceptions
H5::DataTypeIException
Description
For detail, please refer to the C layer Reference Manual at: http://www.hdfgroup.org/HDF5/doc/RM/RM_H5T.html#Datatype-SetStrpad

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