de.htw.berlin.polysun4diac.plugins

Class AbstractActorController

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

All Implemented Interfaces:

IPluginController

Direct Known Subclasses:

BatteryActorController, GenericActorController, PVActorController

public abstract class AbstractActorController
extends AbstractSingleComponentController

Defines the default behaviour of a FORTE actor plugin controller for receiving control signals from IEC 61499 applications running on 4diac-RTE (FORTE).

Author:

Marc Jakobi

HTW Berlin

July 2017

Field Summary

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

INVALID_INDEX

Constructor Summary

Constructors

Constructor and Description
AbstractActorController()

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

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

disconnect

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

getCreator, getVersion, initialiseSimulation, terminateSimulation

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

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

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

getConfiguration, getName

Constructor Detail

AbstractActorController

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

Throws:

com.velasolaris.plugin.controller.spi.PluginControllerException

Method Detail

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.

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.