My Project 1.10.4
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
18namespace H5 {
19
27// Inheritance: DataType -> H5Object -> H5Location -> IdComponent
28class H5_DLLCPP AtomType : public DataType {
29 public:
30 // Returns the byte order of an atomic datatype.
31 H5T_order_t getOrder() const;
32 H5T_order_t getOrder(H5std_string& order_string) const;
33
34 // Sets the byte ordering of an atomic datatype.
35 void setOrder(H5T_order_t order) const;
36
37 // Retrieves the bit offset of the first significant bit.
38 // 12/05/00 - changed return type to int from size_t - C API
39 int getOffset() const;
40
41 // Sets the bit offset of the first significant bit.
42 void setOffset(size_t offset) const;
43
44 // Retrieves the padding type of the least and most-significant bit padding.
45 void getPad(H5T_pad_t& lsb, H5T_pad_t& msb) const;
46
47 // Sets the least and most-significant bits padding types
48 void setPad(H5T_pad_t lsb, H5T_pad_t msb) const;
49
50 // Returns the precision of an atomic datatype.
51 size_t getPrecision() const;
52
53 // Sets the precision of an atomic datatype.
54 void setPrecision(size_t precision) const;
55
56 // Sets the total size for an atomic datatype.
57 void setSize(size_t size) const;
58
60 virtual H5std_string fromClass () const { return("AtomType"); }
61
62#ifndef DOXYGEN_SHOULD_SKIP_THIS
63 // Copy constructor: same as the original AtomType.
64 AtomType(const AtomType& original);
65
66 // Noop destructor
67 virtual ~AtomType();
68#endif // DOXYGEN_SHOULD_SKIP_THIS
69
70 protected:
71#ifndef DOXYGEN_SHOULD_SKIP_THIS
72 // Default constructor
73 AtomType();
74
75 // Constructor that takes an existing id
76 AtomType(const hid_t existing_id);
77#endif // DOXYGEN_SHOULD_SKIP_THIS
78
79}; // end of AtomType
80} // namespace H5
81
82#endif // __H5AtomType_H
AtomType is a base class, inherited by IntType, FloatType, StrType, and PredType.
Definition: H5AtomType.h:28
virtual H5std_string fromClass() const
Returns this class name.
Definition: H5AtomType.h:60
Class DataType provides generic operations on HDF5 datatypes.
Definition: H5DataType.h:28
Definition: H5AbstractDs.cpp:34


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