Line data Source code
1 : // EnergyPlus, Copyright (c) 1996-2025, The Board of Trustees of the University of Illinois,
2 : // The Regents of the University of California, through Lawrence Berkeley National Laboratory
3 : // (subject to receipt of any required approvals from the U.S. Dept. of Energy), Oak Ridge
4 : // National Laboratory, managed by UT-Battelle, Alliance for Sustainable Energy, LLC, and other
5 : // contributors. All rights reserved.
6 : //
7 : // NOTICE: This Software was developed under funding from the U.S. Department of Energy and the
8 : // U.S. Government consequently retains certain rights. As such, the U.S. Government has been
9 : // granted for itself and others acting on its behalf a paid-up, nonexclusive, irrevocable,
10 : // worldwide license in the Software to reproduce, distribute copies to the public, prepare
11 : // derivative works, and perform publicly and display publicly, and to permit others to do so.
12 : //
13 : // Redistribution and use in source and binary forms, with or without modification, are permitted
14 : // provided that the following conditions are met:
15 : //
16 : // (1) Redistributions of source code must retain the above copyright notice, this list of
17 : // conditions and the following disclaimer.
18 : //
19 : // (2) Redistributions in binary form must reproduce the above copyright notice, this list of
20 : // conditions and the following disclaimer in the documentation and/or other materials
21 : // provided with the distribution.
22 : //
23 : // (3) Neither the name of the University of California, Lawrence Berkeley National Laboratory,
24 : // the University of Illinois, U.S. Dept. of Energy nor the names of its contributors may be
25 : // used to endorse or promote products derived from this software without specific prior
26 : // written permission.
27 : //
28 : // (4) Use of EnergyPlus(TM) Name. If Licensee (i) distributes the software in stand-alone form
29 : // without changes from the version obtained under this License, or (ii) Licensee makes a
30 : // reference solely to the software portion of its product, Licensee must refer to the
31 : // software as "EnergyPlus version X" software, where "X" is the version number Licensee
32 : // obtained under this License and may not use a different name for the software. Except as
33 : // specifically required in this Section (4), Licensee shall not use in a company name, a
34 : // product name, in advertising, publicity, or other promotional activities any name, trade
35 : // name, trademark, logo, or other designation of "EnergyPlus", "E+", "e+" or confusingly
36 : // similar designation, without the U.S. Department of Energy's prior written consent.
37 : //
38 : // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR
39 : // IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
40 : // AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
41 : // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
42 : // CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
43 : // SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
44 : // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
45 : // OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
46 : // POSSIBILITY OF SUCH DAMAGE.
47 :
48 : #ifndef DataOutputs_hh_INCLUDED
49 : #define DataOutputs_hh_INCLUDED
50 :
51 : // C++ Headers
52 : #include <cstddef>
53 : #include <unordered_map>
54 : #include <vector>
55 :
56 : // ObjexxFCL Headers
57 : #include <ObjexxFCL/Array1D.hh>
58 :
59 : // EnergyPlus Headers
60 : #include "re2/re2.h"
61 : #include <EnergyPlus/Data/BaseData.hh>
62 : #include <EnergyPlus/DataGlobals.hh>
63 : #include <EnergyPlus/EnergyPlus.hh>
64 : #include <EnergyPlus/UtilityRoutines.hh>
65 :
66 : namespace EnergyPlus {
67 :
68 : namespace DataOutputs {
69 :
70 : // TODO: keep only one of these two
71 : bool isKeyRegexLike(std::string_view key);
72 : bool isKeyRegexLikeOri(std::string_view key); // DataOutputs implementation
73 :
74 : int constexpr NumMonthlyReports(63);
75 :
76 : extern Array1D_string const MonthlyNamedReports;
77 :
78 : struct OutputReportingVariables
79 : {
80 : OutputReportingVariables(EnergyPlusData &state, std::string const &KeyValue, std::string const &VariableName);
81 :
82 : std::string const key;
83 : std::string const variableName;
84 : bool is_simple_string = true;
85 : std::shared_ptr<RE2> pattern = nullptr;
86 : std::shared_ptr<RE2> case_insensitive_pattern = nullptr;
87 : };
88 :
89 : // Check if a KeyValue/VariableName is inside the map OutputVariablesForSimulation
90 : bool FindItemInVariableList(const EnergyPlusData &state, std::string_view const KeyedValue, std::string_view const VariableName);
91 :
92 : } // namespace DataOutputs
93 :
94 : struct OutputsData : BaseGlobalStruct
95 : {
96 :
97 : int MaxConsideredOutputVariables = 0; // Max Array size for OutputVariable pre-scanned
98 : int NumConsideredOutputVariables = 0; // Number of variables - pre-scanned, allowed for output
99 : int iNumberOfRecords = 0; // Number of records in input
100 : int iNumberOfDefaultedFields = 0; // number of defaulted fields
101 : int iTotalFieldsWithDefaults = 0; // number of fields that can be defaulted
102 : int iNumberOfAutoSizedFields = 0; // number of autosized fields
103 : int iTotalAutoSizableFields = 0; // number of fields that can be autosized
104 : int iNumberOfAutoCalcedFields = 0; // number of autocalculated fields
105 : int iTotalAutoCalculatableFields = 0; // number of fields that can be autocalculated
106 : std::map<std::string,
107 : std::map<std::string,
108 : DataOutputs::OutputReportingVariables,
109 : // Util::case_insensitive_hasher,
110 : Util::case_insensitive_comparator>,
111 : // Util::case_insensitive_hasher,
112 : Util::case_insensitive_comparator>
113 : OutputVariablesForSimulation;
114 :
115 2126 : void init_constant_state([[maybe_unused]] EnergyPlusData &state) override
116 : {
117 2126 : }
118 :
119 1152 : void init_state([[maybe_unused]] EnergyPlusData &state) override
120 : {
121 1152 : }
122 :
123 2100 : void clear_state() override
124 : {
125 2100 : new (this) OutputsData();
126 2100 : }
127 : };
128 :
129 : } // namespace EnergyPlus
130 :
131 : #endif
|
