de.labAlive.core.wiringComponent

Class BaseWiringComponent

java.lang.Object

de.labAlive.core.wiringComponent.SignalingComponent

de.labAlive.core.wiringComponent.BaseWiringComponent

Direct Known Subclasses:

WiringComponentImpl

public abstract class BaseWiringComponent
extends SignalingComponent

Abstract class for systems and wires. Implements common tasks, e.g. Ta handling. Simulation: Forwards signal from stepPre to MeasureSet plotStep(sig). Parameter: Dummy implementation of notifyParameterChanged(). Signaling: Ta is set. SigMess is forwarded to MeasureSet.

Constructor Summary

Constructors

Constructor and Description
BaseWiringComponent()

Method Summary

Modifier and Type	Method and Description
void	addSelectParameter(java.lang.String label, java.lang.Object selectedValue, java.lang.Object[] selectableValues, java.lang.String key) Convenient method to add a SelectParameter to the standard Parameter set.
abstract void	checkConnection()
abstract void	createMeasures() Signaling:
Parameters	getMainParameters()
Measures	getMeasures()
java.lang.String	getName() (full) name of the WC as shown in the PropertyWindow
ParametersSet	getParameters()
double	getSamplingTime()
Signal	getSignalType()
Signal	initSignalType(Signal signalType)
void	interceptStep(Signal sig)
void	notifyBeforeParameterChange(Parameters changedParameters) Parameter:
void	notifyPropertyChangedPre() Parameters have changed (sent by DefaultSystemMeasure).
void	putParameters(Parameters parameters) Adds Parameters to the WC ParametersSet
void	putParams(Params<?,?> params) Adds Parameters to the WC ParametersSet
void	setAutoshow() Convenient method to be used in Wirings.
void	setAutoshow(int xWindowLocation, int yWindowLocation) Convenient method to be used in Wirings.
void	setMeasures(Measures measures) Sets MeasureSet of this WC
void	setParametersSet(ParametersSet parametersSet)
void	setParamsSet(ParamsSet paramsSet)
void	setSamplingTime(double ta)
Signal	setSignalType(Signal signalType)
void	setStepInterceptor(StepInterceptor stepInterceptor)
abstract void	step(Signal sig) Is implemented in Wire and Systems.
void	stepPre(Signal sig) Signal coming to the WC (Ports call stepPre).

Methods inherited from class de.labAlive.core.wiringComponent.SignalingComponent

discoverStartableSystems, getFacade, getSignalingReceiver, initDelay, processSignaling, resetSimulation, setFacade, setSignalingReceiver

Methods inherited from class java.lang.Object

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

Constructor Detail

BaseWiringComponent

public BaseWiringComponent()

Method Detail

getMainParameters

public Parameters getMainParameters()

Returns:

Main parameters of the WC

putParameters

public void putParameters(Parameters parameters)

Adds Parameters to the WC ParametersSet

Parameters:

parameters -

putParams

public void putParams(Params<?,?> params)

Adds Parameters to the WC ParametersSet

Parameters:

params - Parameters facade

setParamsSet

public void setParamsSet(ParamsSet paramsSet)

getParameters

public ParametersSet getParameters()

setParametersSet

public void setParametersSet(ParametersSet parametersSet)

addSelectParameter

public void addSelectParameter(java.lang.String label,
                               java.lang.Object selectedValue,
                               java.lang.Object[] selectableValues,
                               java.lang.String key)

Convenient method to add a SelectParameter to the standard Parameter set. Adds all items to the list of selectable values. (Used by systems implementations, e.g. SignalGenerator)

Parameters:

label - label (name) of the SelectParameter as it is display in the PropertyWindow

selectedValue - preselected value

selectableValues - all selectable values

key - unique key to put and get this SelectParameter.

getSamplingTime

public double getSamplingTime()

Returns:

samling time ta

setSamplingTime

public void setSamplingTime(double ta)

getMeasures

public Measures getMeasures()

Returns:

MeasureSet of this WC

setMeasures

public void setMeasures(Measures measures)

Sets MeasureSet of this WC

Parameters:

measureSet -

getSignalType

public Signal getSignalType()

setSignalType

public Signal setSignalType(Signal signalType)

initSignalType

public Signal initSignalType(Signal signalType)

stepPre

public void stepPre(Signal sig)

Signal coming to the WC (Ports call stepPre). Make some general step preparations, e.g. sends plotstep to measureSet, then calls step().

Parameters:

sig - Signal

interceptStep

public void interceptStep(Signal sig)

setStepInterceptor

public void setStepInterceptor(StepInterceptor stepInterceptor)

getName

public java.lang.String getName()

(full) name of the WC as shown in the PropertyWindow

Returns:

Name of the WC

step

public abstract void step(Signal sig)

Is implemented in Wire and Systems.

notifyBeforeParameterChange

public void notifyBeforeParameterChange(Parameters changedParameters)

Parameter:

notifyPropertyChangedPre

public void notifyPropertyChangedPre()

Parameters have changed (sent by DefaultSystemMeasure). See system.

createMeasures

public abstract void createMeasures()

Signaling:

checkConnection

public abstract void checkConnection()

setAutoshow

public void setAutoshow(int xWindowLocation,
                        int yWindowLocation)

Convenient method to be used in Wirings. The default measure (properties window / osci) will be automatically opened during initialization (processSignaling).

Parameters:

xWindowLocation - x location where the properties window will be placed.

yWindowLocation - y location where the properties window will be placed.

setAutoshow

public void setAutoshow()

Convenient method to be used in Wirings. The default measure (properties window / osci) will be automatically opened during initialization (processSignaling).