de.htw.berlin.polysun4diac.plugins

Class BatteryActorController

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

de.htw.berlin.polysun4diac.plugins.BatteryActorController

All Implemented Interfaces:

IPluginController

public class BatteryActorController
extends AbstractActorController

Plugin controller for receiving the battery's set power from 4diac-RTE (FORTE). The actor takes an LREAL as the first control signal for the set power and a BOOL for the battery's control mode.

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
BatteryActorController()

Method Summary

Modifier and Type	Method and Description
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.

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

control, getPropertiesToHide

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

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

BatteryActorController

public BatteryActorController()
                       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

getConfiguration

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

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.