Main Page

00001 // C++ informative line for the emacs editor: -*- C++ -*-
00002 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
00003  * Copyright by the Board of Trustees of the University of Illinois.         *
00004  * All rights reserved.                                                      *
00005  *                                                                           *
00006  * This file is part of HDF5.  The full HDF5 copyright notice, including     *
00007  * terms governing use, modification, and redistribution, is contained in    *
00008  * the files COPYING and Copyright.html.  COPYING can be found at the root   *
00009  * of the source code distribution tree; Copyright.html can be found at the  *
00010  * root level of an installed copy of the electronic HDF5 document set and   *
00011  * is linked from the top-level documents page.  It can also be found at     *
00012  * http://hdf.ncsa.uiuc.edu/HDF5/doc/Copyright.html.  If you do not have     *
00013  * access to either file, you may request a copy from hdfhelp@ncsa.uiuc.edu. *
00014  * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
00015 
00016 #ifndef _H5StrType_H
00017 #define _H5StrType_H
00018 
00019 #ifndef H5_NO_NAMESPACE
00020 namespace H5 {
00021 #endif
00022 
00023 class H5_DLLCPP StrType : public AtomType {
00024    public:
00025         // Creates a string type using a predefined type
00026         StrType(const PredType& pred_type);
00027 
00028         // Creates a string type with specified length
00029         StrType(const size_t& size);
00030 
00031         // Creates a string type with specified length - will be obsolete
00032         StrType(const PredType& pred_type, const size_t size);
00033 
00034         // Gets the string datatype of the specified dataset
00035         StrType(const DataSet& dataset);
00036 
00037         // Retrieves the character set type of this string datatype.
00038         H5T_cset_t getCset() const;
00039 
00040         // Sets character set to be used.
00041         void setCset(H5T_cset_t cset) const;
00042 
00043         // Retrieves the string padding method for this string datatype.
00044         H5T_str_t getStrpad() const;
00045 
00046         // Defines the storage mechanism for character strings.
00047         void setStrpad(H5T_str_t strpad) const;
00048 
00049         // Returns this class name
00050         virtual string fromClass () const { return ("StrType"); }
00051 
00052         // default constructor
00053         StrType();
00054 
00055         // Creates a string datatype using an existing id
00056         StrType(const hid_t existing_id);
00057 
00058         // Copy constructor - makes a copy of the original object
00059         StrType(const StrType& original);
00060 
00061         // Noop destructor.
00062         virtual ~StrType();
00063 };
00064 #ifndef H5_NO_NAMESPACE
00065 }
00066 #endif
00067 #endif
H5StrType.h
