IOSS 2.0

Ioss_NamedSuffixVariableType.h
Go to the documentation of this file.
1 /*
2 * Copyright(C) 1999-2017 National Technology & Engineering Solutions
3 * of Sandia, LLC (NTESS). Under the terms of Contract DE-NA0003525 with
4 * NTESS, the U.S. Government retains certain rights in this software.
5 *
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions are
8 * met:
9 *
10 * * Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 *
13 * * Redistributions in binary form must reproduce the above
14 * copyright notice, this list of conditions and the following
15 * disclaimer in the documentation and/or other materials provided
16 * with the distribution.
17 *
18 * * Neither the name of NTESS nor the names of its
19 * contributors may be used to endorse or promote products derived
20 * from this software without specific prior written permission.
21 *
22 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
23 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
24 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
25 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
26 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
27 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
28 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
29 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
30 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
31 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
32 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
33 */
34 #ifndef IOSS_Ioss_NamedSuffixVariableType_h
35 #define IOSS_Ioss_NamedSuffixVariableType_h
36
37 #include <Ioss_CodeTypes.h>
38 #include <string>
39
40 #include <Ioss_VariableType.h>
41
42 namespace Ioss {
43 class NamedSuffixVariableType : public VariableType
44 {
45 public:
46 // 'which' is 1-based
47 std::string label(int which, const char suffix_sep = '_') const override
48 {
49 return suffixList[which - 1];
50 }
51
52 NamedSuffixVariableType(const std::string &my_name, int number_components, bool delete_me)
53 : Ioss::VariableType(my_name, number_components, delete_me)
54 {
55 suffixList.resize(number_components);
56 suffixList.assign(number_components, "UNSET");
57 }
58
59 //! Define the suffix list for this field.
60 // 'which' is 1-based to conform to the 'label' function usage.
61 // If user doesn't add suffices, then 'label' will return "UNSET"
62 void add_suffix(size_t which, const std::string &suffix) { suffixList[which - 1] = suffix; }
63
64 private:
65 NamedSuffixVariableType(const NamedSuffixVariableType &);
66 std::vector<std::string> suffixList;
67 };
68 } // namespace Ioss
69
70 #endif
Ioss_CodeTypes.h
Ioss
The main namespace for the Ioss library.
Definition: Iocgns_DatabaseIO.h:50
Ioss::NamedSuffixVariableType
Definition: Ioss_NamedSuffixVariableType.h:43
Ioss_VariableType.h
Ioss::VariableType
A generic variable type.
Definition: Ioss_VariableType.h:93
Ioss::NamedSuffixVariableType::add_suffix
void add_suffix(size_t which, const std::string &suffix)
Define the suffix list for this field.
Definition: Ioss_NamedSuffixVariableType.h:62
Ioss::NamedSuffixVariableType::NamedSuffixVariableType
NamedSuffixVariableType(const std::string &my_name, int number_components, bool delete_me)
Definition: Ioss_NamedSuffixVariableType.h:52
Ioss::NamedSuffixVariableType::label
std::string label(int which, const char suffix_sep='_') const override
Definition: Ioss_NamedSuffixVariableType.h:47
Ioss::NamedSuffixVariableType::suffixList
std::vector< std::string > suffixList
Definition: Ioss_NamedSuffixVariableType.h:66