IOSS 2.0

Ioss_State.h
Go to the documentation of this file.
1 // Copyright(C) 1999-2017 National Technology & Engineering Solutions
2 // of Sandia, LLC (NTESS). Under the terms of Contract DE-NA0003525 with
3 // NTESS, the U.S. Government retains certain rights in this software.
4 //
5 // Redistribution and use in source and binary forms, with or without
6 // modification, are permitted provided that the following conditions are
7 // met:
8 //
9 // * Redistributions of source code must retain the above copyright
10 // notice, this list of conditions and the following disclaimer.
11 //
12 // * Redistributions in binary form must reproduce the above
13 // copyright notice, this list of conditions and the following
14 // disclaimer in the documentation and/or other materials provided
15 // with the distribution.
16 //
17 // * Neither the name of NTESS nor the names of its
18 // contributors may be used to endorse or promote products derived
19 // from this software without specific prior written permission.
20 //
21 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23 // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
24 // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
25 // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
26 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
27 // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
28 // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
29 // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
30 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
31 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
32
33 #ifndef IOSS_Ioss_State_h
34 #define IOSS_Ioss_State_h
35 namespace Ioss {
36
37 /** \brief Access states for a database.
38 *
39 * All access states except STATE_INVALID, STATE_UNKNOWN, and STATE_READONLY are only
40 * for output databases.
41 */
42 enum State {
43 STATE_INVALID = -1, /**< Error state if something goes wrong. */
44 STATE_UNKNOWN, /**< Typically used at the very beginning of the database's existence
45 when the class has been created, but no reading or writing has
46 occurred. */
47 STATE_READONLY, /**< An input database that is not in STATE_UNKNOWN is in this
48 state, which means that it cannot be written to or changed. */
49 STATE_CLOSED, /**< The sates are not nested, so each state must end with a transition
50 to this state prior to entering the next state. */
51 STATE_DEFINE_MODEL, /**< Defining the metadata, which defines the topology of the model
52 (nontransient, geometry and topology). */
53 STATE_MODEL, /**< Outputting the bulk data (mesh_model_coordinates, ids, connectivity)
54 relating to the model portion. */
55 STATE_DEFINE_TRANSIENT, /**< Defining the metadata relating to the transient data. For example,
56 the element or nodal fields. */
57 STATE_TRANSIENT, /**< Outputting the transient bulk data. */
58 STATE_LAST_ENTRY
59 };
60 } // namespace Ioss
61 #endif
Ioss::STATE_READONLY
Definition: Ioss_State.h:47
Ioss
The main namespace for the Ioss library.
Definition: Iocgns_DatabaseIO.h:50
Ioss::STATE_MODEL
Definition: Ioss_State.h:53
Ioss::STATE_UNKNOWN
Definition: Ioss_State.h:44
Ioss::STATE_DEFINE_MODEL
Definition: Ioss_State.h:51
Ioss::STATE_INVALID
Definition: Ioss_State.h:43
Ioss::State
State
Access states for a database.
Definition: Ioss_State.h:42
Ioss::STATE_TRANSIENT
Definition: Ioss_State.h:57
Ioss::STATE_CLOSED
Definition: Ioss_State.h:49
Ioss::STATE_LAST_ENTRY
Definition: Ioss_State.h:58
Ioss::STATE_DEFINE_TRANSIENT
Definition: Ioss_State.h:55