public class ScheduleCsvImportSettings
extends java.lang.Object
Modifier and Type | Class and Description |
---|---|
class |
ScheduleCsvImportSettings.InterfaceImportSettings
This class collects all relevant import settings for a single technical interface
|
class |
ScheduleCsvImportSettings.VariableImportSettings
This class collects all relevant import settings for a single system variable
|
Modifier and Type | Field and Description |
---|---|
static EnergyUnitFactorPrefixSI |
DEFAULT_SI_PREFIX_FOR_ENERGY_AMOUNTS |
static EnergyUnitFactorPrefixSI |
DEFAULT_SI_PREFIX_FOR_ENERGY_FLOWS |
static TimeUnit |
DEFAULT_TIME_UNIT_FOR_ENERGY_AMOUNTS |
Constructor and Description |
---|
ScheduleCsvImportSettings() |
Modifier and Type | Method and Description |
---|---|
void |
addInterfaceImportSettings(ScheduleCsvImportSettings.InterfaceImportSettings interfaceSettings)
Adds an InterfaceImportSettings instance to the list
|
ScheduleCsvImportSettings.InterfaceImportSettings |
addNewInterfaceImportSettings(TechnicalInterface technicalInterface)
Creates a new InterfaceImportSettings instance and adds it to the InterfaceImportSettings Vector.
|
ScheduleCsvImportSettings.VariableImportSettings |
addNewVariableImportSettings(java.lang.String variableID)
Creates a new VariableImportSettings instance with the given variable ID and adds it to the list
|
void |
addVariableImportSettings(ScheduleCsvImportSettings.VariableImportSettings variableSettings)
Adds a VariabeImportSettings instance to the list
|
int |
getColumnIndexForConfigurationID()
Gets the CSV column index for the configuration ID
|
int |
getColumnIndexForEnergyLosses()
Gets the CSV column index for the state duration
|
int |
getColumnIndexForGlobalTime()
Gets the CSV column index for the state's global time
|
int |
getColumnIndexForResultingCosts()
Gets the CSV data column for the resulting costs
|
int |
getColumnIndexForStateCosts()
Gets the CSV data column for the state costs
|
int |
getColumnIndexForStateID()
Gets the CSV column index for the state ID
|
java.lang.String |
getFixedConfigurationID()
Gets the fixed configuration ID
|
java.lang.String |
getFixedStateID()
Gets the fixed state ID
|
ScheduleCsvImportSettings.InterfaceImportSettings |
getInterfaceImportSettings(int index)
Gets the InterfaceImportSettings instance with the given index
|
ScheduleCsvImportSettings.InterfaceImportSettings |
getInterfaceImportSettingsByInterfaceID(java.lang.String interfaceID)
Looks for an
ScheduleCsvImportSettings.InterfaceImportSettings instance with the given interface ID |
java.util.Vector<ScheduleCsvImportSettings.InterfaceImportSettings> |
getInterfaceImportSettingsVector()
Returns the Vector of InterfaceImportSettings .
|
java.lang.String |
getNetworkID()
Gets the network ID
|
java.lang.String |
getSystemID()
Gets the system ID
|
java.lang.String |
getTimeFormat()
Gets the time format for the global time column
|
ScheduleCsvImportSettings.VariableImportSettings |
getVariableImportSettingsByVariableID(java.lang.String variableID)
Looks for a VariableImportSettings instance with the given variable ID
|
java.util.Vector<ScheduleCsvImportSettings.VariableImportSettings> |
getVariableImportSettingsVector()
Gets the all variable import settings.
|
ScheduleCsvImportSettings.VariableImportSettings |
getVariableSettings(int index)
Get the VariableImportSettings instance with the given index
|
boolean |
isClearScheduleList()
If this returns true, existing schedules will be removed before importing, otherwise the imported schedule will be appended to the list
|
void |
removeInterfaceImportSettingsByInterfaceID(java.lang.String interfaceID)
Removes the InterfaceImportSettings instance with the given interface ID from the list
|
void |
removeVariableImportSettingsByVariableID(java.lang.String variableID)
Removes the VariableImportSettings instance with the given variable ID from the list
|
void |
setClearScheduleList(boolean clearScheduleList)
If this is set to true, existing schedules will be removed before importing, otherwise the imported schedule will be appended to the list
|
void |
setColumnIndexForConfigurationID(int columnIndexForConfigurationID)
Sets the CSV column index for the configuration ID
|
void |
setColumnIndexForEnergyLosses(int columnIndexForEnergyLosses)
Sets the CSV column index for the state duration
|
void |
setColumnIndexForGlobalTime(int columnIndexForGlobalTime)
Sets the CSV column index for the state's global time
|
void |
setColumnIndexForResultingCosts(int columnIndexForResultingCosts)
Sets the CSV data column for the resulting costs
|
void |
setColumnIndexForStateCosts(int columnIndexForStateCosts)
Sets the CSV data column for the state costs
|
void |
setColumnIndexForStateID(int columnIndexForStateID)
Sets the CSV data column index for the state ID
|
void |
setFixedConfigurationID(java.lang.String fixedConfigurationID)
Sets the fixed configuration ID
|
void |
setFixedStateID(java.lang.String fixedStateID)
Sets the fixed state ID
|
void |
setNetworkID(java.lang.String networkID)
Sets the network ID
|
void |
setSystemID(java.lang.String systemID)
Sets the system ID
|
void |
setTimeFormat(java.lang.String timeFormat)
Sets the time format for the global time column
|
public static final EnergyUnitFactorPrefixSI DEFAULT_SI_PREFIX_FOR_ENERGY_FLOWS
public static final EnergyUnitFactorPrefixSI DEFAULT_SI_PREFIX_FOR_ENERGY_AMOUNTS
public static final TimeUnit DEFAULT_TIME_UNIT_FOR_ENERGY_AMOUNTS
public java.lang.String getSystemID()
public void setSystemID(java.lang.String systemID)
systemID
- The system id to setpublic boolean isClearScheduleList()
public void setClearScheduleList(boolean clearScheduleList)
clearScheduleList
- Clear the schedule list?public java.lang.String getNetworkID()
public void setNetworkID(java.lang.String networkID)
networkID
- The network ID to setpublic java.lang.String getTimeFormat()
public void setTimeFormat(java.lang.String timeFormat)
timeFormat
- The time format for the global time columnpublic int getColumnIndexForConfigurationID()
public void setColumnIndexForConfigurationID(int columnIndexForConfigurationID)
columnIndexForConfigurationID
- The CSV column index for the configuration IDpublic int getColumnIndexForStateID()
public void setColumnIndexForStateID(int columnIndexForStateID)
columnIndexForStateID
- The CSV data column index for the state IDpublic java.lang.String getFixedConfigurationID()
public void setFixedConfigurationID(java.lang.String fixedConfigurationID)
fixedConfigurationID
- public java.lang.String getFixedStateID()
public void setFixedStateID(java.lang.String fixedStateID)
fixedStateID
- public int getColumnIndexForGlobalTime()
public void setColumnIndexForGlobalTime(int columnIndexForGlobalTime)
columnIndexForGlobalTime
- The CSV column index for the state's global timepublic int getColumnIndexForStateCosts()
public void setColumnIndexForStateCosts(int columnIndexForStateCosts)
columnIndexForStateCosts
- The CSV data column for the state costspublic int getColumnIndexForResultingCosts()
public void setColumnIndexForResultingCosts(int columnIndexForResultingCosts)
columnIndexForResultingCosts
- The CSV data column for the resulting costspublic int getColumnIndexForEnergyLosses()
public void setColumnIndexForEnergyLosses(int columnIndexForEnergyLosses)
columnIndexForEnergyLosses
- The CSV column index for the state durationpublic void addInterfaceImportSettings(ScheduleCsvImportSettings.InterfaceImportSettings interfaceSettings)
interfaceSettings
- The InterfaceImportSettings instance to addpublic ScheduleCsvImportSettings.InterfaceImportSettings getInterfaceImportSettings(int index)
index
- The indexpublic java.util.Vector<ScheduleCsvImportSettings.InterfaceImportSettings> getInterfaceImportSettingsVector()
public ScheduleCsvImportSettings.InterfaceImportSettings addNewInterfaceImportSettings(TechnicalInterface technicalInterface)
technicalInterface
- the technical interfaceScheduleCsvImportSettings.InterfaceImportSettings
instancepublic ScheduleCsvImportSettings.InterfaceImportSettings getInterfaceImportSettingsByInterfaceID(java.lang.String interfaceID)
ScheduleCsvImportSettings.InterfaceImportSettings
instance with the given interface IDinterfaceID
- The interface ID to look forpublic void removeInterfaceImportSettingsByInterfaceID(java.lang.String interfaceID)
interfaceID
- The ID of the interface to be removedpublic void addVariableImportSettings(ScheduleCsvImportSettings.VariableImportSettings variableSettings)
variableSettings
- The VariableImportSettings to addpublic ScheduleCsvImportSettings.VariableImportSettings getVariableSettings(int index)
index
- The indexpublic java.util.Vector<ScheduleCsvImportSettings.VariableImportSettings> getVariableImportSettingsVector()
public ScheduleCsvImportSettings.VariableImportSettings addNewVariableImportSettings(java.lang.String variableID)
variableID
- The variable IDScheduleCsvImportSettings.VariableImportSettings
instancepublic ScheduleCsvImportSettings.VariableImportSettings getVariableImportSettingsByVariableID(java.lang.String variableID)
variableID
- The variable ID to look forpublic void removeVariableImportSettingsByVariableID(java.lang.String variableID)
variableID
- The variable ID