HDF5 C++ API  1.10.1
 All Classes Namespaces Functions Variables Typedefs Friends Pages
H5AtomType.h
1 // C++ informative line for the emacs editor: -*- C++ -*-
2 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
3  * Copyright by The HDF Group. *
4  * Copyright by the Board of Trustees of the University of Illinois. *
5  * All rights reserved. *
6  * *
7  * This file is part of HDF5. The full HDF5 copyright notice, including *
8  * terms governing use, modification, and redistribution, is contained in *
9  * the COPYING file, which can be found at the root of the source code *
10  * distribution tree, or in https://support.hdfgroup.org/ftp/HDF5/releases. *
11  * If you do not have access to either file, you may request a copy from *
12  * help@hdfgroup.org. *
13  * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
14 
15 #ifndef __H5AtomType_H
16 #define __H5AtomType_H
17 
18 namespace H5 {
19 
24 // Inheritance: DataType -> H5Object -> H5Location -> IdComponent
25 class H5_DLLCPP AtomType : public DataType {
26  public:
27  // Returns the byte order of an atomic datatype.
28  H5T_order_t getOrder() const;
29  H5T_order_t getOrder(H5std_string& order_string) const;
30 
31  // Sets the byte ordering of an atomic datatype.
32  void setOrder(H5T_order_t order) const;
33 
34  // Retrieves the bit offset of the first significant bit.
35  // 12/05/00 - changed return type to int from size_t - C API
36  int getOffset() const;
37 
38  // Sets the bit offset of the first significant bit.
39  void setOffset(size_t offset) const;
40 
41  // Retrieves the padding type of the least and most-significant bit padding.
42  void getPad(H5T_pad_t& lsb, H5T_pad_t& msb) const;
43 
44  // Sets the least and most-significant bits padding types
45  void setPad(H5T_pad_t lsb, H5T_pad_t msb) const;
46 
47  // Returns the precision of an atomic datatype.
48  size_t getPrecision() const;
49 
50  // Sets the precision of an atomic datatype.
51  void setPrecision(size_t precision) const;
52 
53  // Sets the total size for an atomic datatype.
54  void setSize(size_t size) const;
55 
57  virtual H5std_string fromClass () const { return("AtomType"); }
58 
59 #ifndef DOXYGEN_SHOULD_SKIP_THIS
60  // Copy constructor - makes copy of the original object
61  AtomType(const AtomType& original);
62 
63  // Noop destructor
64  virtual ~AtomType();
65 #endif // DOXYGEN_SHOULD_SKIP_THIS
66 
67  protected:
68 #ifndef DOXYGEN_SHOULD_SKIP_THIS
69  // Default constructor
70  AtomType();
71 
72  // Constructor that takes an existing id
73  AtomType(const hid_t existing_id);
74 #endif // DOXYGEN_SHOULD_SKIP_THIS
75 
76 }; // end of AtomType
77 } // namespace H5
78 
79 #endif // __H5AtomType_H
Class DataType provides generic operations on HDF5 datatypes.
Definition: H5DataType.h:28
AtomType is a base class, inherited by IntType, FloatType, StrType, and PredType. ...
Definition: H5AtomType.h:25
virtual H5std_string fromClass() const
Returns this class name.
Definition: H5AtomType.h:57


The HDF Group Help Desk:
  Copyright by The HDF Group
and the Board of Trustees of the University of Illinois