com.velasolaris.plugin.controller.spi

Class AbstractPluginController

java.lang.Object

com.velasolaris.plugin.controller.spi.AbstractPluginController

All Implemented Interfaces:

IPluginController

Direct Known Subclasses:

Abstract4diacPluginController

public abstract class AbstractPluginController
extends java.lang.Object
implements IPluginController

Abstract plugin controller containing convenience code. Concrete plugin controllers should inherit from this class instead of directly from the ControllerPlugin interface.

Since:

Polysun 9.1

Author:

rkurmann

Field Summary

Fields inherited from interface com.velasolaris.plugin.controller.spi.IPluginController

INVALID_INDEX

Constructor Summary

Constructors

Constructor and Description
AbstractPluginController()

Method Summary

Modifier and Type	Method and Description
void	addPreSimulatableComponent(java.lang.String key, com.velasolaris.plugin.controller.spi.IPreSimulatable component) Adds an IPreSimulatable component.
void	build(com.velasolaris.plugin.controller.spi.PolysunSettings polysunSettings, java.util.Map<java.lang.String,java.lang.Object> parameters) Method to pass Polysun properties to this plugin controller.
void	closeResources() Closes resources and cleans up.
java.lang.String	exportResource(java.lang.String resourceName, java.lang.String destFolder, boolean onlyFile) Export a resource embedded into a Jar file to the local file path.
com.velasolaris.plugin.controller.spi.PluginControllerConfiguration.ControlSignal	getControlSignal(java.lang.String controlSignalName) Returns the control signal setting for a control signal name.
int	getControlSignalIndex(java.lang.String controlSignalName) Returns the array index for the control signal name.
java.util.List<com.velasolaris.plugin.controller.spi.PluginControllerConfiguration.ControlSignal>	getControlSignals() Returns all control signals (configured and generic).
java.util.List<java.lang.String>	getControlSignalsToHide(com.velasolaris.plugin.controller.spi.PolysunSettings polysunSettings, java.util.Map<java.lang.String,java.lang.Object> parameters) Determines the controlSignals which must be hidden in the current configuration.
boolean[]	getControlSignalsUsed() Returns an boolean array for control signals where true at i if this control signal is used in Polysun.
java.lang.String	getCreator() The creator of this plugin controller.
int	getCSIdx(java.lang.String controlSignalName) Returns the array index for the control signal name.
java.lang.String	getDescription() A short description of this plugin controller.
java.lang.String	getDocumentation() Documentation of this plugin controller.
int	getFixedTimestep(java.util.Map<java.lang.String,java.lang.Object> parameters) Fixed timestep.
java.lang.String	getId() Returns the technical ID of the plugin controller, i.e.
java.util.List<com.velasolaris.plugin.controller.spi.PluginControllerConfiguration.Log>	getLogs() Returns all logs.
com.velasolaris.plugin.controller.spi.PolysunSettings.PropertyValue	getProp(java.lang.String propertyName) Returns the property value for a given name Convenience method with a shorter method name.
java.util.List<java.lang.String>	getPropertiesToHide(com.velasolaris.plugin.controller.spi.PolysunSettings polysunSettings, java.util.Map<java.lang.String,java.lang.Object> parameters) Determines the GUI properties which must be hidden in the current configuration.
com.velasolaris.plugin.controller.spi.PolysunSettings.PropertyValue	getProperty(java.lang.String propertyName) Returns the property value for a given name
int	getPropertyIndex(java.lang.String propertyName) Gets the index of a property in the property array method.
com.velasolaris.plugin.controller.spi.PolysunSettings.PropertyValue	getPropertyValue(int index) Gets the property value for a property name as set by the user in the plugin controller GUI.
com.velasolaris.plugin.controller.spi.PolysunSettings.PropertyValue	getPropertyValue(java.lang.String propertyName) Gets the property value for a property name as set by the user in the plugin controller GUI.
com.velasolaris.plugin.controller.spi.PluginControllerConfiguration.Sensor	getSensor(java.lang.String sensorName) Returns the sensor setting for a sensor name.
float	getSensor(java.lang.String sensorName, float[] sensors) Returns the value of a sensor given by name.
int	getSensorIndex(java.lang.String sensorName) Returns the array index for the sensor name.
java.util.List<com.velasolaris.plugin.controller.spi.PluginControllerConfiguration.Sensor>	getSensors() Returns the all sensors (configured and generic).
java.util.List<java.lang.String>	getSensorsToHide(com.velasolaris.plugin.controller.spi.PolysunSettings polysunSettings, java.util.Map<java.lang.String,java.lang.Object> parameters) Determines the sensors which must be hidden in the current configuration.
int	getSnIdx(java.lang.String sensorName) Returns the array index for the sensor name.
java.lang.String	getVersion() The version of this plugin controller.
void	initialiseSimulation(java.util.Map<java.lang.String,java.lang.Object> parameters) This method is called once before the simulation starts.
boolean	isEnabled(java.util.Map<java.lang.String,java.lang.Object> parameters) Is this plugin controller enabled?
boolean	isPreSimulatableComponentAvailable(java.lang.String key) Checks the availability of a pre-simulatable component.
void	setControlSignal(java.lang.String controlSignalName, float value, float[] controlSignals) Sets the control signal given by name with the given value to the control signal array.
void	terminateSimulation(java.util.Map<java.lang.String,java.lang.Object> parameters) This method is called once after the simulation.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.velasolaris.plugin.controller.spi.IPluginController

control, getConfiguration, getName

Constructor Detail

AbstractPluginController

public AbstractPluginController()

Method Detail

getId

public java.lang.String getId()

Returns the technical ID of the plugin controller, i.e. the class name of the plugin controller.

Returns:

Technical id (String representation of the class name)

build

public void build(com.velasolaris.plugin.controller.spi.PolysunSettings polysunSettings,
                  java.util.Map<java.lang.String,java.lang.Object> parameters)
           throws com.velasolaris.plugin.controller.spi.PluginControllerException

Description copied from interface: IPluginController

Method to pass Polysun properties to this plugin controller. E.g. plugin controller GUI settings. This method is called when Polysun plugin controller in Polysun is built, e.g. a plugin controller property has been changed by the user. The state of the current configuration could be kept for later use during the simulation.

Specified by:

build in interface IPluginController

Parameters:

polysunSettings - The properties and settings of Polysun

parameters - Generic parameters

Throws:

com.velasolaris.plugin.controller.spi.PluginControllerException - if there is a problem creating the plugin controller configuration.

getControlSignal

public com.velasolaris.plugin.controller.spi.PluginControllerConfiguration.ControlSignal getControlSignal(java.lang.String controlSignalName)

Returns the control signal setting for a control signal name.

Parameters:

controlSignalName - the name of the control signal

Returns:

the control signal setting, or null if not found

getControlSignalIndex

public int getControlSignalIndex(java.lang.String controlSignalName)

Returns the array index for the control signal name.

Parameters:

controlSignalName - the name of the signal name

Returns:

array index, or -1 if not found

See Also:

getCSIdx(String)

getControlSignals

public java.util.List<com.velasolaris.plugin.controller.spi.PluginControllerConfiguration.ControlSignal> getControlSignals()

Returns all control signals (configured and generic).

Returns:

List of control signals in the order as shown in the GUI (configured control signals and genric control signals). The same order is also used in the control signal float array of IPluginController.control(int, boolean, float[], float[], float[], boolean, Map).

See Also:

PolysunSettings.getControlSignals()

getControlSignalsToHide

public java.util.List<java.lang.String> getControlSignalsToHide(com.velasolaris.plugin.controller.spi.PolysunSettings polysunSettings,
                                                                java.util.Map<java.lang.String,java.lang.Object> parameters)

Description copied from interface: IPluginController

Determines the controlSignals which must be hidden in the current configuration.

Specified by:

getControlSignalsToHide in interface IPluginController

Parameters:

polysunSettings - The configuration Polysun, user settings of properties

parameters - Generic parameters

Returns:

The list control signal names that must be hidden in the given configuration.

getControlSignalsUsed

public boolean[] getControlSignalsUsed()

Returns an boolean array for control signals where true at i if this control signal is used in Polysun.

Returns:

boolean array indicating if a control signal is set in Polysun configuration

getCreator

public java.lang.String getCreator()

Description copied from interface: IPluginController

The creator of this plugin controller. E.g. "Vela Solaris". This method is called if the creator of the plugin controller is required.

Specified by:

getCreator in interface IPluginController

Returns:

Plain text or null if there is creator.

getCSIdx

public int getCSIdx(java.lang.String controlSignalName)

Returns the array index for the control signal name. Convenience method with a shorter method name.

Parameters:

controlSignalName - the name of the signal name

Returns:

array index, or -1 if not found

See Also:

getControlSignalIndex(String)

getDescription

public java.lang.String getDescription()

Description copied from interface: IPluginController

A short description of this plugin controller. E.g. "Controls the status (on/off) of one or two different components and the flowrate of a given pump based on two flowrate sensors." This method is called if a description of the plugin controller is shown.

Specified by:

getDescription in interface IPluginController

Returns:

Plain text or null if there is no description

getDocumentation

public java.lang.String getDocumentation()

Description copied from interface: IPluginController

Documentation of this plugin controller. This method is called if a documentation of the plugin controller is shown.

Specified by:

getDocumentation in interface IPluginController

Returns:

Plain text or HTML or null if there is no description

getLogs

public java.util.List<com.velasolaris.plugin.controller.spi.PluginControllerConfiguration.Log> getLogs()

Returns all logs.

Returns:

List of logs in the order as declared.

See Also:

PolysunSettings.getLogs()

getProp

public com.velasolaris.plugin.controller.spi.PolysunSettings.PropertyValue getProp(java.lang.String propertyName)

Returns the property value for a given name Convenience method with a shorter method name.

Parameters:

propertyName - name of the property

Returns:

the property value or null if not found

getPropertiesToHide

public java.util.List<java.lang.String> getPropertiesToHide(com.velasolaris.plugin.controller.spi.PolysunSettings polysunSettings,
                                                            java.util.Map<java.lang.String,java.lang.Object> parameters)

Description copied from interface: IPluginController

Determines the GUI properties which must be hidden in the current configuration. E.g. if the flowrate is not fixed, the Fixflowrate property must be hidden.

Specified by:

getPropertiesToHide in interface IPluginController

Parameters:

polysunSettings - The configuration Polysun, user settings of properties

parameters - Generic parameters

Returns:

The list property names that must be hidden in the given configuration.

getProperty

public com.velasolaris.plugin.controller.spi.PolysunSettings.PropertyValue getProperty(java.lang.String propertyName)

Returns the property value for a given name

Parameters:

propertyName - name of the property

Returns:

the property value or null if not found

See Also:

getProp(String)

getPropertyValue

public com.velasolaris.plugin.controller.spi.PolysunSettings.PropertyValue getPropertyValue(int index)

Gets the property value for a property name as set by the user in the plugin controller GUI.

Parameters:

index - index of the property as name given in PluginControllerConfiguration.

Returns:

property value or null if not found

getPropertyValue

public com.velasolaris.plugin.controller.spi.PolysunSettings.PropertyValue getPropertyValue(java.lang.String propertyName)

Gets the property value for a property name as set by the user in the plugin controller GUI.

Parameters:

propertyName - name of the property as name given in PluginControllerConfiguration. Generic properties are named with PolysunSettings.GENERIC_PROPERTY_PREFIX + number where the number starts with 1, e.g. PluginControllerProperty1.

Returns:

property value or null if not found

getPropertyIndex

public int getPropertyIndex(java.lang.String propertyName)

Gets the index of a property in the property array method.

Parameters:

propertyName - name of the property as name given in PluginControllerConfiguration. Generic properties are named with PolysunSettings.GENERIC_PROPERTY_PREFIX + number where the number starts with 1, e.g. PluginControllerProperty1.

Returns:

the index in the float array, or -1 if not found

getSensor

public com.velasolaris.plugin.controller.spi.PluginControllerConfiguration.Sensor getSensor(java.lang.String sensorName)

Returns the sensor setting for a sensor name.

Parameters:

sensorName - the name of the sensor

Returns:

the sensor setting, or null if not found

getSensor

public float getSensor(java.lang.String sensorName,
                       float[] sensors)

Returns the value of a sensor given by name.

Parameters:

sensorName - the name of the sensor

sensors - the sensor array

Returns:

the value for the sensor given by name

See Also:

getSnIdx(String)

getSensorIndex

public int getSensorIndex(java.lang.String sensorName)

Returns the array index for the sensor name.

Parameters:

sensorName - the name of the sensor

Returns:

array index, or -1 if not found

getSensors

public java.util.List<com.velasolaris.plugin.controller.spi.PluginControllerConfiguration.Sensor> getSensors()

Returns the all sensors (configured and generic).

Returns:

List of sensors in the order as shown in the GUI (configured sensors and generic sensors). The same order is also used in the control signal float array of IPluginController.control(int, boolean, float[], float[], float[], boolean, Map).

See Also:

PolysunSettings.getSensors()

getSensorsToHide

public java.util.List<java.lang.String> getSensorsToHide(com.velasolaris.plugin.controller.spi.PolysunSettings polysunSettings,
                                                         java.util.Map<java.lang.String,java.lang.Object> parameters)

Description copied from interface: IPluginController

Determines the sensors which must be hidden in the current configuration. E.g. if the flowrate is fixed, the flowrate sensor must be hidden.

Specified by:

getSensorsToHide in interface IPluginController

Parameters:

polysunSettings - The configuration Polysun, user settings of properties

parameters - Generic parameters

Returns:

The list sensor names that must be hidden in the given configuration.

getSnIdx

public int getSnIdx(java.lang.String sensorName)

Returns the array index for the sensor name. Convenience method with a shorter method name.

Parameters:

sensorName - the name of the sensor

Returns:

array index, or -1 if not found

See Also:

getSensorIndex(String)

getVersion

public java.lang.String getVersion()

Description copied from interface: IPluginController

The version of this plugin controller. E.g. "1.0". This method is called if the version of the plugin controller is required.

Specified by:

getVersion in interface IPluginController

Returns:

Plain text (semantic versioning suggested) or null if there is no version

getFixedTimestep

public int getFixedTimestep(java.util.Map<java.lang.String,java.lang.Object> parameters)

Description copied from interface: IPluginController

Fixed timestep. For each timepoint which is a multiple of this fixedTimestep, the simulation does a timestep. The Polysun solver can do more timesteps if necessary. Example, for fixedTimestep of 180s, the simulation solver does a simulation at least at 0s, 180s, 360s, 480s, 720s, ...

Specified by:

getFixedTimestep in interface IPluginController

Parameters:

parameters - General parameters

Returns:

The fixed timestep, or a value less than 1 for the default timestep (240s during day and 720s during the night)

initialiseSimulation

public void initialiseSimulation(java.util.Map<java.lang.String,java.lang.Object> parameters)
                          throws com.velasolaris.plugin.controller.spi.PluginControllerException

Description copied from interface: IPluginController

This method is called once before the simulation starts.

Specified by:

initialiseSimulation in interface IPluginController

Parameters:

parameters - Generic parameters

Throws:

com.velasolaris.plugin.controller.spi.PluginControllerException - if there is a problem

isEnabled

public boolean isEnabled(java.util.Map<java.lang.String,java.lang.Object> parameters)

Description copied from interface: IPluginController

Is this plugin controller enabled?

Specified by:

isEnabled in interface IPluginController

Parameters:

parameters - Generic parameters

Returns:

true if enabled, otherwise false

setControlSignal

public void setControlSignal(java.lang.String controlSignalName,
                             float value,
                             float[] controlSignals)

Sets the control signal given by name with the given value to the control signal array.

Parameters:

controlSignalName - the name of the control siganl

value - the value to set

controlSignals - the array to change

terminateSimulation

public void terminateSimulation(java.util.Map<java.lang.String,java.lang.Object> parameters)

Description copied from interface: IPluginController

This method is called once after the simulation.

Specified by:

terminateSimulation in interface IPluginController

Parameters:

parameters - Generic parameters

exportResource

public java.lang.String exportResource(java.lang.String resourceName,
                                       java.lang.String destFolder,
                                       boolean onlyFile)
                                throws java.io.FileNotFoundException,
                                       java.io.IOException

Export a resource embedded into a Jar file to the local file path. Ref. http://stackoverflow.com/questions/10308221/how-to-copy-file-inside-jar-to-outside-the-jar

Parameters:

resourceName - ie.: "/control.m"

destFolder - the destination folder

onlyFile - should the only the file without resource path be exported?

Returns:

The path to the exported resource

Throws:

java.io.FileNotFoundException - if file not found

java.io.IOException - for I/O problems

closeResources

public void closeResources()

Description copied from interface: IPluginController

Closes resources and cleans up. This method is called if resources should be freed. Examples: Close files, disconnect connections

Specified by:

closeResources in interface IPluginController

addPreSimulatableComponent

public void addPreSimulatableComponent(java.lang.String key,
                                       com.velasolaris.plugin.controller.spi.IPreSimulatable component)

Description copied from interface: IPluginController

Adds an IPreSimulatable component. The components are added by Polysun. For the implementation, see the AbstractPluginController.

Specified by:

addPreSimulatableComponent in interface IPluginController

See Also:

AbstractPluginController, IPreSimulatable

isPreSimulatableComponentAvailable

public boolean isPreSimulatableComponentAvailable(java.lang.String key)

Description copied from interface: IPluginController

Checks the availability of a pre-simulatable component. Components are added to the controller after the IPluginController.initialiseSimulation(Map) method is called. Thus, this method will only return true during the simulation.

Specified by:

isPreSimulatableComponentAvailable in interface IPluginController

Returns:

true if the component is available, false otherwise.

See Also:

IPreSimulatable