de.htw.berlin.polysun4diac.plugins

Class Abstract4diacPluginController

java.lang.Object

com.velasolaris.plugin.controller.spi.AbstractPluginController

de.htw.berlin.polysun4diac.plugins.Abstract4diacPluginController

All Implemented Interfaces:

IPluginController

Direct Known Subclasses:

AbstractSingleComponentController

public abstract class Abstract4diacPluginController
extends AbstractPluginController

Abstract class for Polysun PluginControllers that communicate with 4diac IEC 61499 applications running on 4diac-RTE (FORTE). If more than one controllers are used, it is recommended to set up the socket as a TCP client.

Author:

Marc Jakobi

HTW Berlin

July 2017

See Also:

CommLayerParams, IForteSocket, IPluginController

Field Summary

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

INVALID_INDEX

Constructor Summary

Constructors

Constructor and Description
Abstract4diacPluginController()

Method Summary

Modifier and Type	Method and Description
java.lang.String	getCreator() The creator of this 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.
void	terminateSimulation(java.util.Map<java.lang.String,java.lang.Object> parameters) This method is called once after the simulation.

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

addPreSimulatableComponent, 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, isPreSimulatableComponentAvailable, 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

control, getConfiguration, getName

Constructor Detail

Abstract4diacPluginController

public Abstract4diacPluginController()

Method Detail

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

Overrides:

getCreator in class AbstractPluginController

Returns:

Plain text or null if there is creator.

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 AbstractPluginController

Returns:

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

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 AbstractPluginController

Parameters:

parameters - Generic parameters

Throws:

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

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

Overrides:

terminateSimulation in class AbstractPluginController

Parameters:

parameters - Generic parameters

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 AbstractPluginController

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.