-
Notifications
You must be signed in to change notification settings - Fork 7
/
Copy pathEnergyPlusDataAPI.java
83 lines (70 loc) · 2.35 KB
/
EnergyPlusDataAPI.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
package main.java.api;
import java.util.HashMap;
import java.util.Map;
import main.java.model.gbXML.ReverseTranslator;
import main.java.model.idf.IDFFileObject;
/**
* API used to register EnergyPlus data
*
*
* @author weilixu
*
*/
public interface EnergyPlusDataAPI {
public String dataBaseName();
public DataBaseType dataBaseType();
/**
* This function allows for translator to check whether this plugin is required to have another plugin to work with
* This usually happens when two plugins carry two pieces of information but these two information should be connected.
* An example is constructions and windows link to orientation of surfaces.
* @return
*/
public HashMap<DataBaseType, String> requiredCoPlugins();
/**
* This is the method that write in a whole system into EnergyPlus file
*
* @param objectFile:
* energyplus
*/
public void writeInSystem(IDFFileObject objectFile, HashMap<String, String> id_to_NameMap);
/**
* This method should only be used for HVAC system since it opened up the whole translator data
* So the function is well equipped with accessing all the building data if necessary
* @param objectFile
* @param translator
*/
public void writeInHVACSystem(IDFFileObject objectFile, ReverseTranslator translator);
/**
* This method allows developer to write in objects that is reserved for later usage
* e.g. thermal zone, write in thermal zones for the space element processing
* @param translator
*/
public void writeInObjects(ReverseTranslator translator);
/**
* get the value from plugin in the format of String
*
* @param identifier
* the identifier for the value, it could be a space type
* (office),
* @return
*/
public String getValueInString(String identifier);
/**
* get the value from plugin in the format of Double
*
* @param identifier
* identifier the identifier for the value, it could be a space
* type (office), or it could be other
* @return
*/
public Double getValueInDouble(String identifier);
/**
* get the value from plugin in the format of Map
*
* @param identifier
* identifier the identifier for the value, it could be a space
* type (office), or it could be other
* @return
*/
public Map<String, String[]> getValuesInHashMap(String identifier);
}