com.velasolaris.plugin.controller.spi

Interface IPluginController

All Known Implementing Classes:

Abstract4diacPluginController, AbstractActorController, AbstractPluginController, AbstractSensorController, AbstractSingleComponentController, BatteryActorController, BatterySensorController, GenericActorController, GenericForteController, GenericSensorController, LoadSensorController, PVActorController, PVSensorController, SGReadyHeatPumpController

public interface IPluginController

Interface for controllers that can be added as plugin to Polysun. I.e. this interface defines a controller. This is the Service Provider Interface (SPI). Objects will be created by the default constructor. Thus, a constructor without any parameters must be available. A plugin controller has uses the following concepts:

• Sensors, input values "measured" in Polysun
• Control signals, the output of the control algorithm
• Logs, intermediate values to log and show in Polysun

. There are configured and generic sensors and control signals. Generic sensors and control signals behave as in ProgrammableController of Polysun. Available values in the general parameters set by Polysun:

• Plugin.DataPath, String: Proposed path for config data, within the Polysun user data folders
• Polysun.UserLevel, Integer: Level of the current license, 2 = Professional, 3 = Designer, 4 = Developer
• Polysun.Version, Long: The current version number, as Long
• Polysun.DataPath, String: Path to the data folder of Polysun.
• Polysun.DataPathAbsolute, String: Absolute path to the data folder of Polysun.
• Polysun.InstallPath, String: Path to the Polysun executable

Available values in the general parameters read by Polysun:

• Plugin.PrintMessage, String or List<String>: Message(s) written to the Polysun MessageArea

Since:

Polysun 9.1

Author:

rkurmann

See Also:

PluginControllerConfiguration

Field Summary

Fields

Modifier and Type	Field and Description
static int	INVALID_INDEX

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.
int[]	control(int simulationTime, boolean status, float[] sensors, float[] controlSignals, float[] logValues, boolean preRun, java.util.Map<java.lang.String,java.lang.Object> parameters) Does the control work.
com.velasolaris.plugin.controller.spi.PluginControllerConfiguration	getConfiguration(java.util.Map<java.lang.String,java.lang.Object> parameters) Configuration of this plugin controllers.
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.
java.lang.String	getCreator() The creator of this plugin controller.
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	getName() The human readable name of the plugin controller.
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.
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.
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	terminateSimulation(java.util.Map<java.lang.String,java.lang.Object> parameters) This method is called once after the simulation.

Field Detail

INVALID_INDEX

static final int INVALID_INDEX

See Also:

Constant Field Values

Method Detail

getName

java.lang.String getName()

The human readable name of the plugin controller. E.g. "Flowrate". This method is called if the name of the plugin controller is required.

Returns:

Short name, must not null

getCreator

java.lang.String getCreator()

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

Returns:

Plain text or null if there is creator.

getVersion

java.lang.String getVersion()

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

Returns:

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

getDescription

java.lang.String getDescription()

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.

Returns:

Plain text or null if there is no description

getDocumentation

java.lang.String getDocumentation()

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

Returns:

Plain text or HTML or null if there is no description

isEnabled

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

Is this plugin controller enabled?

Parameters:

parameters - Generic parameters

Returns:

true if enabled, otherwise false

getConfiguration

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

Configuration of this plugin controllers. E.g. the properties in the controller setting GUI, the sensors, the log values and the signals to control. This method is called when the plugin controller in Polysun is created and every time when the variant is reloaded.

Parameters:

parameters - Generic parameters

Returns:

Plugin controller configuration. Must not be null.

Throws:

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

build

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

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.

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.

getPropertiesToHide

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. E.g. if the flowrate is not fixed, the Fixflowrate property must be hidden.

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.

getSensorsToHide

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. E.g. if the flowrate is fixed, the flowrate sensor must be hidden.

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.

getControlSignalsToHide

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.

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.

getFixedTimestep

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

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, ...

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

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

This method is called once before the simulation starts.

Parameters:

parameters - Generic parameters

Throws:

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

control

int[] control(int simulationTime,
              boolean status,
              float[] sensors,
              float[] controlSignals,
              float[] logValues,
              boolean preRun,
              java.util.Map<java.lang.String,java.lang.Object> parameters)
       throws com.velasolaris.plugin.controller.spi.PluginControllerException

Does the control work. This method is called each timestep by Polysun if signals must be controlled according to the sensor values.

Parameters:

simulationTime - The simulation time in [s] beginning from the 1. January 00:00 (no leap year).

status - The status of this controller according to user settings, true means enabled, false disabled. The status originates from the timer setting of the controller dialog. The user can enable or disable the controller for certain hours, days or month. This value should be respected by the controller implementation, otherwise it could lead to an unexpected user experience.

sensors - The values of the sensors configured by the user (Input parameter).

controlSignals - The control signals set by this plugin controller (Output parameter).

logValues - The values to log in Polysun, e.g intermediate results. This value can be ignored. These values are shown in the Simulation Analysis or in the Log and Parameterizing output.

preRun - Is this the real simulation or a pre run phase? This value can be ignored.

parameters - Generic parameters

Returns:

Timepoints [s]. Registers these timepoints in the future, where the simulation have to do a timestep. It doesn't matter, if the same timepoint will be registered several times. Timepoint in the array is in seconds from the 1. Jan. 00:00, or null if no additional timesteps are required. These timesteps can be used for time based controlling strategies.

Throws:

com.velasolaris.plugin.controller.spi.PluginControllerException - if there is a problem. The simulation will be aborted.

terminateSimulation

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

This method is called once after the simulation.

Parameters:

parameters - Generic parameters

closeResources

void closeResources()

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

addPreSimulatableComponent

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

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

See Also:

AbstractPluginController, IPreSimulatable

isPreSimulatableComponentAvailable

boolean isPreSimulatableComponentAvailable(java.lang.String key)

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

Returns:

true if the component is available, false otherwise.

See Also:

IPreSimulatable