de.htw.berlin.polysun4diac.plugins

Class GenericForteController

java.lang.Object

com.velasolaris.plugin.controller.spi.AbstractPluginController

de.htw.berlin.polysun4diac.plugins.Abstract4diacPluginController

de.htw.berlin.polysun4diac.plugins.AbstractSingleComponentController

de.htw.berlin.polysun4diac.plugins.GenericForteController

All Implemented Interfaces:

IPluginController

public class GenericForteController
extends AbstractSingleComponentController

Plugin controller for sending data to and receiving data from IEC 61499 applications running on 4diac-RTE (FORTE).

Author:

Marc Jakobi

HTW Berlin

July 2017

See Also:

IForteSocket, CommLayerParams, IPluginController

Field Summary

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

INVALID_INDEX

Constructor Summary

Constructors

Constructor and Description
GenericForteController()

Method Summary

Modifier and Type	Method and Description
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.lang.String	getDescription() A short description of this plugin controller.
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 propertyValues, java.util.Map<java.lang.String,java.lang.Object> parameters) Determines the GUI properties 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.

Methods inherited from class de.htw.berlin.polysun4diac.plugins.AbstractSingleComponentController

disconnect

Methods inherited from class de.htw.berlin.polysun4diac.plugins.Abstract4diacPluginController

getCreator, terminateSimulation

Methods inherited from class com.velasolaris.plugin.controller.spi.AbstractPluginController

addPreSimulatableComponent, build, closeResources, exportResource, getControlSignal, getControlSignalIndex, getControlSignals, getControlSignalsToHide, getControlSignalsUsed, getCSIdx, getDocumentation, getFixedTimestep, getId, getLogs, getProp, getProperty, getPropertyIndex, getPropertyValue, getPropertyValue, getSensor, getSensor, getSensorIndex, getSensors, getSensorsToHide, getSnIdx, isEnabled, isPreSimulatableComponentAvailable, setControlSignal

Methods inherited from class java.lang.Object

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

Constructor Detail

GenericForteController

public GenericForteController()
                       throws com.velasolaris.plugin.controller.spi.PluginControllerException

Throws:

com.velasolaris.plugin.controller.spi.PluginControllerException

Method Detail

getName

public java.lang.String getName()

Description copied from interface: IPluginController

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

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

Overrides:

getDescription in class AbstractPluginController

Returns:

Plain text or null if there is no description

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

Overrides:

getVersion in class Abstract4diacPluginController

Returns:

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

getConfiguration

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

Description copied from interface: IPluginController

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.

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

Overrides:

initialiseSimulation in class Abstract4diacPluginController

Parameters:

parameters - Generic parameters

Throws:

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

getPropertiesToHide

public java.util.List<java.lang.String> getPropertiesToHide(com.velasolaris.plugin.controller.spi.PolysunSettings propertyValues,
                                                            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

Overrides:

getPropertiesToHide in class Abstract4diacPluginController

Parameters:

propertyValues - The configuration Polysun, user settings of properties

parameters - Generic parameters

Returns:

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

control

public 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

Description copied from interface: IPluginController

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.