IOSS 2.0

Ioss_NullEntity.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_NullEntity_h
34 #define IOSS_Ioss_NullEntity_h
35
36 #include <Ioss_CodeTypes.h>
37 #include <Ioss_GroupingEntity.h>
38 #include <string>
39
40 namespace Ioss {
41 class DatabaseIO;
42
43 class NullEntity : public GroupingEntity
44 {
45 public:
46 NullEntity() : Ioss::GroupingEntity(nullptr, "null_entity", 0) {}
47
48 std::string type_string() const override { return "NullEntity"; }
49 std::string short_type_string() const override { return "null"; }
50 std::string contains_string() const override { return "Nothing"; }
51 EntityType type() const override { return INVALID_TYPE; }
52
53 // Handle implicit properties -- These are calcuated from data stored
54 // in the grouping entity instead of having an explicit value assigned.
55 // An example would be 'element_block_count' for a region.
56 Property get_implicit_property(const std::string &my_name) const override
57 {
58 return Ioss::GroupingEntity::get_implicit_property(my_name);
59 }
60
61 protected:
62 int64_t internal_get_field_data(const Field &, void *, size_t) const override { return 0; }
63
64 int64_t internal_put_field_data(const Field &, void *, size_t) const override { return 0; }
65 };
66 } // namespace Ioss
67 #endif
Ioss::Field
Holds metadata for bulk data associated with a GroupingEntity.
Definition: Ioss_Field.h:47
Ioss::NullEntity::get_implicit_property
Property get_implicit_property(const std::string &my_name) const override
Calculate and get an implicit property.
Definition: Ioss_NullEntity.h:56
Ioss
The main namespace for the Ioss library.
Definition: Ioad_DatabaseIO.C:66
Ioss::NullEntity::type_string
std::string type_string() const override
Get the name of the particular type of entity.
Definition: Ioss_NullEntity.h:48
Ioss::INVALID_TYPE
Definition: Ioss_EntityType.h:55
Ioss::GroupingEntity::get_implicit_property
virtual Property get_implicit_property(const std::string &my_name) const =0
Calculate and get an implicit property.
Definition: Ioss_GroupingEntity.C:172
Ioss::EntityType
EntityType
The particular type of GroupingEntity.
Definition: Ioss_EntityType.h:39
Ioss::NullEntity::internal_put_field_data
int64_t internal_put_field_data(const Field &, void *, size_t) const override
Definition: Ioss_NullEntity.h:64
Ioss::NullEntity::NullEntity
NullEntity()
Definition: Ioss_NullEntity.h:46
Ioss::NullEntity::type
EntityType type() const override
Get the EntityType, which indicates the particular type of GroupingEntity this is.
Definition: Ioss_NullEntity.h:51
Ioss::NullEntity::short_type_string
std::string short_type_string() const override
Get a short name of the particular type of entity.
Definition: Ioss_NullEntity.h:49
Ioss_GroupingEntity.h
Ioss::NullEntity::internal_get_field_data
int64_t internal_get_field_data(const Field &, void *, size_t) const override
Definition: Ioss_NullEntity.h:62
Ioss::NullEntity
Definition: Ioss_NullEntity.h:43
Ioss::NullEntity::contains_string
std::string contains_string() const override
What does this entity contain.
Definition: Ioss_NullEntity.h:50
Ioss::Property
A named value that has a known type.
Definition: Ioss_Property.h:47
Ioss::GroupingEntity
Base class for all 'grouping' entities. The following derived classes are typical:
Definition: Ioss_GroupingEntity.h:93
Ioss_CodeTypes.h