2 # ---------------------------------------------------------------------
4 # Copyright (c) CREATIS (Centre de Recherche en Acquisition et Traitement de l'Image
6 # Authors : Eduardo Davila, Frederic Cervenansky, Claire Mouton
7 # Previous Authors : Laurent Guigues, Jean-Pierre Roux
8 # CreaTools website : www.creatis.insa-lyon.fr/site/fr/creatools_accueil
10 # This software is governed by the CeCILL-B license under French law and
11 # abiding by the rules of distribution of free software. You can use,
12 # modify and/ or redistribute the software under the terms of the CeCILL-B
13 # license as circulated by CEA, CNRS and INRIA at the following URL
14 # http://www.cecill.info/licences/Licence_CeCILL-B_V1-en.html
15 # or in the file LICENSE.txt.
17 # As a counterpart to the access to the source code and rights to copy,
18 # modify and redistribute granted by the license, users are provided only
19 # with a limited warranty and the software's author, the holder of the
20 # economic rights, and the successive licensors have only limited
23 # The fact that you are presently reading this means that you have had
24 # knowledge of the CeCILL-B license and that you accept its terms.
25 # ------------------------------------------------------------------------
27 #ifndef BRUKERFIELDDATA_H
28 #define BRUKERFIELDDATA_H
29 /*! \file brukerFieldData.h
33 #include "brukerSystem.h"
36 \class BrukerFieldData
37 \brief This class is an atom to generate a BrukerDataSet
39 class /*creaBruker_EXPORT*/ BrukerFieldData
41 friend class BrukerDataSet;
43 /*! \brief Constructor
45 BrukerFieldData () {};
48 ~BrukerFieldData (){};
49 /*! \brief Returns the keyword type: int, float, string as a string
51 const std::string &GetDataType() { return DataType;}
52 /*! \fn int GetDimensionNumber()
53 \brief Returns the dimension of the keyword:
59 int GetDimensionNumber() { return DimensionNumber;}
60 /*! \fn const std::vector<int> &GetDimensionNumberValue( )
61 \brief Returns a vector of size DimensionNumber giving the size of each dimension of the keyword
63 const std::vector<int> &GetDimensionNumberValue( ) { return DimensionNumberValue;}
64 /*! \fn int GetNumberOfElements()
65 \brief Returns the total number of elements for keyword
67 int GetNumberOfElements() { return NumberOfElements;}
69 \fn const std::vector<std::string> &GetStringValue()
70 \brief Return a string vector of all the element of keyword
72 const std::vector<std::string> &GetStringValue() { return StringValue;}
74 \fn const std::vector<int> &GetIntValue ()
75 \brief Return an int vector of all the element of keyword
77 const std::vector<int> &GetIntValue () { return IntValue;}
79 \fn const std::vector<double> &GetDoubleValue()
80 \brief Return a double vector of all the element of keyword
82 const std::vector<double> &GetDoubleValue() { return DoubleValue;}
89 \brief Datatype of the keyword content
92 /*! \var DimensionNumber
93 \brief Dimmensionnality of the keyword
96 /*! \var DimensionNumberValue
97 \brief Vector of int giving the dimension of each dimension of the keyword content
99 std::vector<int> DimensionNumberValue;
100 /*! \var NumberOfElements
101 \brief Total number of elements contained in keyword
103 int NumberOfElements;
105 \brief Vector of string containing the elements of keyword if they are string
107 std::vector<std::string> StringValue;
109 \brief Vector of string containing the elements of keyword if they are string
111 std::vector<int> IntValue;
113 \brief Vector of string containing the elements of keyword if they are string
115 std::vector<double> DoubleValue;