de.labAlive.measure

Class Parameters

java.lang.Object

java.util.AbstractMap<K,V>

java.util.HashMap<K,V>

java.util.LinkedHashMap<java.lang.Object,Parameter>

de.labAlive.core.parameters.parameters.ParametersAndDisplayParameters

de.labAlive.measure.Parameters

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.util.Map<java.lang.Object,Parameter>

Direct Known Subclasses:

ChannelSpecificMeterParameters, MonitorParameters, PlayAudioParameters, PowerMeterParameters, SignalLoggingParameters, SignalViewerParameters, UdpSinkParameters, XYMeterParameters

public class Parameters
extends ParametersAndDisplayParameters

Set of Parameters accessible via Keyword. It is the data model that is viewed and controlled by PropertyWindow and used by a Display implementation or a WC, e.g. SigGen. Special measure parameter as OsciParameter are implemented as subclasses and override getMeasureName(). Note: - Do NOT place Properties as members! They are not cloned.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class java.util.AbstractMap

java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>

Field Summary

Fields

Modifier and Type	Field and Description
java.util.Map<java.lang.String,AutoStartActionParameter>	autoStartActionParameters
MeterI	meter
MeterSize	meterSize

Fields inherited from class de.labAlive.core.parameters.parameters.ParametersAndDisplayParameters

referer

Constructor Summary

Constructors

Constructor and Description
Parameters()

Method Summary

Modifier and Type	Method and Description
java.util.Collection<java.lang.String>	actionParameterKeys(ParameterDetailLevel propertyWindowDetailLevel)
MeterI	activateMeter(Measure measure)
MeasureProperty	addParameter(java.lang.Object parameterKey)
void	addParameter(Parameter parameter)
void	adWcName(java.lang.String wcName2)
void	build()
void	checkParamterNotNull()
Parameters	clone()
Parameters	copy(Parameters pFrom, Parameters pTo)
ActionParameter	getActionParameter(java.lang.String key)
java.awt.Point	getLocation()
MeasureFactory	getMeasureFactory()
java.lang.String	getMeasureName()
java.lang.String	getMeasureType()
MeasureNotificationReceiver	getNotificationReceiver()
Parameter	getParameter(java.lang.Object parameterKey)
Parameter	getParameter(java.lang.String key)
java.util.Collection<Parameter>	getReadOnlyParameters(ParameterDetailLevel propertyWindowDetailLevel)
double	getSamplingTime()
SelectParameter	getSelectParameter(java.lang.String key)
java.awt.Dimension	getSize()
double	getStepsPerSecond()
int	getVisibleChangeableAndReadOnlyParametersSize(ParameterDetailLevel propertyWindowDetailLevel)
java.util.Collection<Parameter>	getVisibleChangeableParameters(ParameterDetailLevel propertyWindowDetailLevel)
java.lang.String	getWcName()
boolean	hasChanged(java.lang.Object parameterKey)
boolean	hasUserChangedSelectParameter()
boolean	isAutoshow()
boolean	isEmpty()
void	meterReInit()
void	meterResize(Width width)
void	notifyBeforeMeasureActivated()
void	notifyMeasureChanged(Measure measure)
void	parametersAndEachParameterProcessDependencies()
void	put(java.lang.String key, ActionParameter actionParameter)
void	put(java.lang.String key, AutoStartActionParameter autoStartActionParameter)
void	put(java.lang.String key, SelectParameter selectParameter)
void	reCreateMeter()
void	resetUserHasChanged()
void	sanityCheck()
boolean	sanityCheck(ParametersAndDisplayParameters handlerParams)
java.util.Collection<java.lang.String>	SelectParameterKeys()
java.util.Collection<java.lang.String>	SelectParameterKeys(ParameterDetailLevel propertyWindowDetailLevel)
void	setAutoshow() Auto opens the measure display, e.g.
void	setAutoshow(boolean autoshow)
void	setLocation(int x, int y)
void	setLocation(java.awt.Point location)
void	setManualMeasureFactory(MeasureFactory manualMeasureFactory)
void	setMeasureType(java.lang.String measureType)
void	setNotificationReceiver(MeasureNotificationReceiver notificationReceiver)
void	setSamplingTime(double ta)
void	setStepsPerSecond(double stepsPerSecond)
void	setWcName(java.lang.String wcName)
java.lang.String	toInstanceId()
java.lang.String	toString()
java.lang.String	toStringDebug()
void	updateParameter(java.lang.String key, double value)
void	validate()

Methods inherited from class de.labAlive.core.parameters.parameters.ParametersAndDisplayParameters

commitDisplayParameterChanges, commitParameterChanges2Display, getDisplayParameters, initDisplayParameters, isDisplay, resetDisplayParameters, rollbackDisplayParameterChanges

Methods inherited from class java.util.LinkedHashMap

clear, containsValue, entrySet, forEach, get, getOrDefault, keySet, replaceAll, values

Methods inherited from class java.util.HashMap

compute, computeIfAbsent, computeIfPresent, containsKey, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, size

Methods inherited from class java.util.AbstractMap

equals, hashCode

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, containsKey, equals, hashCode, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, size

Field Detail

meterSize

public MeterSize meterSize

autoStartActionParameters

public java.util.Map<java.lang.String,AutoStartActionParameter> autoStartActionParameters

meter

public MeterI meter

Constructor Detail

Parameters

public Parameters()

Method Detail

getMeasureName

public java.lang.String getMeasureName()

Returns:

name of the measure that uses the parameter, per default "Property Window" is the default measure of a system. It is displayed in the choice when user right clicks on a wire or system. Special measure parameter as OsciParameter override getMeasureName().

getMeasureType

public final java.lang.String getMeasureType()

setWcName

public void setWcName(java.lang.String wcName)

adWcName

public void adWcName(java.lang.String wcName2)

getWcName

public java.lang.String getWcName()

setMeasureType

public void setMeasureType(java.lang.String measureType)

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface java.util.Map<java.lang.Object,Parameter>

Overrides:

isEmpty in class java.util.HashMap<java.lang.Object,Parameter>

meterResize

public void meterResize(Width width)

getSize

public java.awt.Dimension getSize()

Returns:

Configured window size for Meter or PropertyWindow.

setSamplingTime

public final void setSamplingTime(double ta)

build

public final void build()

getSamplingTime

public double getSamplingTime()

getLocation

public java.awt.Point getLocation()

setLocation

public void setLocation(int x,
                        int y)

setLocation

public void setLocation(java.awt.Point location)

setAutoshow

public void setAutoshow()

Auto opens the measure display, e.g. Osci or PropertyWindow.

setAutoshow

public void setAutoshow(boolean autoshow)

isAutoshow

public boolean isAutoshow()

put

public void put(java.lang.String key,
                SelectParameter selectParameter)

put

public void put(java.lang.String key,
                ActionParameter actionParameter)

put

public void put(java.lang.String key,
                AutoStartActionParameter autoStartActionParameter)

getSelectParameter

public SelectParameter getSelectParameter(java.lang.String key)

getParameter

public Parameter getParameter(java.lang.String key)

hasUserChangedSelectParameter

public boolean hasUserChangedSelectParameter()

getActionParameter

public ActionParameter getActionParameter(java.lang.String key)

SelectParameterKeys

public java.util.Collection<java.lang.String> SelectParameterKeys()

SelectParameterKeys

public java.util.Collection<java.lang.String> SelectParameterKeys(ParameterDetailLevel propertyWindowDetailLevel)

actionParameterKeys

public java.util.Collection<java.lang.String> actionParameterKeys(ParameterDetailLevel propertyWindowDetailLevel)

getVisibleChangeableParameters

public java.util.Collection<Parameter> getVisibleChangeableParameters(ParameterDetailLevel propertyWindowDetailLevel)

getVisibleChangeableAndReadOnlyParametersSize

public int getVisibleChangeableAndReadOnlyParametersSize(ParameterDetailLevel propertyWindowDetailLevel)

getReadOnlyParameters

public java.util.Collection<Parameter> getReadOnlyParameters(ParameterDetailLevel propertyWindowDetailLevel)

clone

public Parameters clone()

Overrides:

clone in class java.util.HashMap<java.lang.Object,Parameter>

sanityCheck

public boolean sanityCheck(ParametersAndDisplayParameters handlerParams)

sanityCheck

public void sanityCheck()

copy

public Parameters copy(Parameters pFrom,
                       Parameters pTo)

activateMeter

public final MeterI activateMeter(Measure measure)

meterReInit

public void meterReInit()

reCreateMeter

public void reCreateMeter()

updateParameter

public void updateParameter(java.lang.String key,
                            double value)

addParameter

public MeasureProperty addParameter(java.lang.Object parameterKey)

addParameter

public void addParameter(Parameter parameter)

getParameter

public Parameter getParameter(java.lang.Object parameterKey)

hasChanged

public boolean hasChanged(java.lang.Object parameterKey)

parametersAndEachParameterProcessDependencies

public final void parametersAndEachParameterProcessDependencies()

Overrides:

parametersAndEachParameterProcessDependencies in class ParametersAndDisplayParameters

validate

public void validate()
              throws IllegalParameterValueException

Throws:

IllegalParameterValueException

getMeasureFactory

public MeasureFactory getMeasureFactory()

setManualMeasureFactory

public void setManualMeasureFactory(MeasureFactory manualMeasureFactory)

notifyBeforeMeasureActivated

public void notifyBeforeMeasureActivated()

notifyMeasureChanged

public void notifyMeasureChanged(Measure measure)

setNotificationReceiver

public void setNotificationReceiver(MeasureNotificationReceiver notificationReceiver)

getNotificationReceiver

public MeasureNotificationReceiver getNotificationReceiver()

getStepsPerSecond

public double getStepsPerSecond()

setStepsPerSecond

public void setStepsPerSecond(double stepsPerSecond)

checkParamterNotNull

public void checkParamterNotNull()

toInstanceId

public java.lang.String toInstanceId()

toString

public java.lang.String toString()

Overrides:

toString in class java.util.AbstractMap<java.lang.Object,Parameter>

toStringDebug

public java.lang.String toStringDebug()

resetUserHasChanged

public void resetUserHasChanged()