artisynth.core.probes

Class NumericDataFunctionProbe

java.lang.Object

artisynth.core.modelbase.ModelComponentBase

artisynth.core.modelbase.ModelAgentBase

artisynth.core.probes.Probe

artisynth.core.probes.NumericProbeBase

artisynth.core.probes.NumericDataFunctionProbe

All Implemented Interfaces:

Displayable, CopyableComponent, HasState, ModelAgent, ModelComponent, PostScannable, java.lang.Cloneable, HasProperties, HierarchyNode, Scannable

Direct Known Subclasses:

NumericControlProbe, NumericMonitorProbe

public abstract class NumericDataFunctionProbe
extends NumericProbeBase
implements CopyableComponent

Base class for a NumericProbe that uses DataFunctions.

Nested Class Summary

Nested classes/interfaces inherited from class artisynth.core.probes.Probe

Probe.ExportProps, Probe.ImportExportFileInfo

Nested classes/interfaces inherited from interface artisynth.core.modelbase.ModelComponent

ModelComponent.NavpanelVisibility

Field Summary

Fields inherited from class artisynth.core.probes.NumericProbeBase

EXPLICIT_TIME, myProps, mySmallDisplay

Fields inherited from class artisynth.core.probes.Probe

useOldSaveMethod, writeStartStopTimeInSeconds

Fields inherited from class artisynth.core.modelbase.ModelComponentBase

enforceUniqueCompositeNames, enforceUniqueNames, myNumber, NULL_OBJ, useCompactPathNames

Fields inherited from interface artisynth.core.modelbase.CopyableComponent

COPY_REFERENCES, REST_POSITION

Constructor Summary

Constructors

Constructor and Description
NumericDataFunctionProbe()

Method Summary

Modifier and Type	Method and Description
java.lang.Object	clone()
ComponentState	createState(ComponentState prevState) Factory routine to create a state object for this component, which can then be used as an argument for HasState.setState(artisynth.core.modelbase.ComponentState) and HasState.getState(artisynth.core.modelbase.ComponentState).
DataFunction	getDataFunction() Returns the data function, if any, that is used by this probe's NumericProbeBase.apply(double) method to apply data for this probe.
void	getInitialState(ComponentState newstate, ComponentState oldstate) Gets an initial state for this component and returns the value in state.
void	getState(ComponentState state) Get the current state of this component.
boolean	hasState() Queries if this component has state.
boolean	isCloneable()
boolean	isDuplicatable() Returns true if this component can be duplicated.
void	setDataFunction(DataFunction func) Sets a data function to be used by this probe, either in NumericControlProbe.applyData(maspack.matrix.VectorNd, double, double) (for NumericControlProbes), or NumericMonitorProbe.generateData(maspack.matrix.VectorNd, double, double) (for NumericMonitorProbes).
void	setState(ComponentState state) Set the state of this component.

Methods inherited from class artisynth.core.probes.NumericProbeBase

addData, apply, applyDefaultDisplayRanges, clearData, createNumericList, decreaseDisplayRanges, dispose, export, getAllPropertyInfo, getAttachedProperties, getData, getDefaultDisplayMax, getDefaultDisplayMin, getDefaultDisplayRange, getDisplay, getDrivers, getExportFileInfo, getExportProps, getFormat, getInterpolation, getInterpolationOrder, getLegend, getMatlabName, getMinMaxValues, getNumericList, getOrderedTraceIndex, getPlotTraceInfo, getRange, getRange, getTraceColor, getTraceLabel, getTraceManager, getValues, getVariables, getVsize, importData, importText, increaseDisplayRanges, isDisplayable, isEmpty, isPrintable, isSmallDisplayVisible, isTraceVisible, isValidVariableName, isWritable, loadFromMatlab, print, read, removeDisplay, removeLegend, resetTraceColors, resetTraceOrder, saveToMatlab, scaleNumericList, setDefaultDisplayRange, setDefaultDisplayRange, setFormat, setInterpolation, setInterpolationOrder, setLegend, setLegendLabels, setScale, setSmallDisplayVisible, setTraceColor, setTraceLabel, setTraceOrder, setTraceVisible, setValues, smoothWithMovingAverage, smoothWithSavitzkyGolay, swapPlotTraceOrder, updateDisplays, updateDisplays, updateDisplaysForPropertyChanges, updateDisplaysWithoutAutoRanging, writeText

Methods inherited from class artisynth.core.probes.Probe

getAttachedFile, getAttachedFileName, getChildren, getClippedVirtualTime, getDefaultScale, getDefaultStartTime, getDefaultStopTime, getDefaultUpdateInterval, getDuration, getExportFile, getExportFileName, getFileFromPath, getImportFile, getImportFileInfo, getImportFileName, getPathFromFile, getProperty, getScale, getStartTime, getStopTime, getTimelineTime, getTrack, getUpdateInterval, getVirtualTime, hasAttachedFile, hasChildren, isAttachedFileRelative, isEventTime, isInput, isScalable, isSettable, load, nextEventTime, save, scan, setAttachedFileName, setData, setExportFileName, setImportFileName, setInterval, setName, setScalable, setStartStopTimes, setStartTime, setStopTime, setTrack, setUpdateInterval

Methods inherited from class artisynth.core.modelbase.ModelAgentBase

finalize, getModel, initialize, isActive, setActive, setModel, setModelFromComponent, write

Methods inherited from class artisynth.core.modelbase.ModelComponentBase

checkFlag, checkName, checkNameUniqueness, clearFlag, connectToHierarchy, copy, createTempFlag, disconnectFromHierarchy, getGrandParent, getHardReferences, getName, getNameRange, getNavpanelVisibility, getNavpanelVisibility, getNumber, getParent, getSoftReferences, isFixed, isMarked, isScanning, isSelected, makeValidName, makeValidName, notifyParentOfChange, postscan, printReferences, recursivelyContained, recursivelyContains, removeTempFlag, setFixed, setFlag, setMarked, setNavpanelVisibility, setNavpanelVisibility, setNumber, setParent, setScanning, setSelected, setWritable, updateReferences

Methods inherited from class java.lang.Object

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

Methods inherited from interface artisynth.core.modelbase.CopyableComponent

copy, getCopyReferences

Methods inherited from interface artisynth.core.modelbase.ModelComponent

connectToHierarchy, disconnectFromHierarchy, getHardReferences, getName, getNavpanelVisibility, getNumber, getParent, getSoftReferences, isFixed, isMarked, isSelected, notifyParentOfChange, scan, setFixed, setMarked, setName, setNumber, setParent, setSelected, setWritable, updateReferences

Methods inherited from interface maspack.properties.HasProperties

getAllPropertyInfo, getProperty

Methods inherited from interface maspack.properties.HierarchyNode

getChildren, hasChildren

Methods inherited from interface artisynth.core.modelbase.PostScannable

postscan

Methods inherited from interface maspack.util.Scannable

isWritable, write

Constructor Detail

NumericDataFunctionProbe

public NumericDataFunctionProbe()

Method Detail

setDataFunction

public void setDataFunction(DataFunction func)

Sets a data function to be used by this probe, either in NumericControlProbe.applyData(maspack.matrix.VectorNd, double, double) (for NumericControlProbes), or NumericMonitorProbe.generateData(maspack.matrix.VectorNd, double, double) (for NumericMonitorProbes). If the data function is set to null, then this probe will do nothing. If the NumericControlProbe.applyData(maspack.matrix.VectorNd, double, double) or NumericMonitorProbe.generateData(maspack.matrix.VectorNd, double, double) method is overridden by a subclass, then the data application is determined instead by the overriding method.

See Also:

getDataFunction()

getDataFunction

public DataFunction getDataFunction()

Returns the data function, if any, that is used by this probe's NumericProbeBase.apply(double) method to apply data for this probe.

See Also:

setDataFunction(artisynth.core.probes.DataFunction)

hasState

public boolean hasState()

Description copied from interface: ModelComponent

Queries if this component has state. Structure change events involving components that have state will cause the current state history of of the system to be cleared.

Specified by:

hasState in interface ModelComponent

Overrides:

hasState in class Probe

Returns:

true if this component has state

createState

public ComponentState createState(ComponentState prevState)

Description copied from interface: HasState

Factory routine to create a state object for this component, which can then be used as an argument for HasState.setState(artisynth.core.modelbase.ComponentState) and HasState.getState(artisynth.core.modelbase.ComponentState). The state object does not have to be set to the component's current state. If the component does not have any state information, this method should return an instance of EmptyState.

Specified by:

createState in interface HasState

Overrides:

createState in class Probe

Parameters:

prevState - If non-null, supplies a previous state that was created by this component and which can be used to provide pre-sizing hints.

Returns:

new object for storing this component's state

getState

public void getState(ComponentState state)

Description copied from interface: HasState

Get the current state of this component.

Specified by:

getState in interface HasState

Overrides:

getState in class Probe

Parameters:

state - receives the state information

setState

public void setState(ComponentState state)

Description copied from interface: HasState

Set the state of this component.

Specified by:

setState in interface HasState

Overrides:

setState in class Probe

Parameters:

state - state to be copied

getInitialState

public void getInitialState(ComponentState newstate,
                            ComponentState oldstate)

Description copied from interface: HasState

Gets an initial state for this component and returns the value in state. If prevstate is non-null, then it is assumed to contain a previous initial state value returned by this method, and state should be set to be as consistent with this previous state as possible. For example, suppose that this component currently contains subcomponents A, B, and C, while the prevstate contains the state from a previous time when it had components B, C, and D. Then state should contain substate values for B and C that are taken from prevstate. To facilitate this, the information returned in state should contain additional information such as the identities of all the (current) subcomponents.

Specified by:

getInitialState in interface HasState

Overrides:

getInitialState in class Probe

Parameters:

newstate - receives the state information

oldstate - previous state information; may be null.

isDuplicatable

public boolean isDuplicatable()

Returns true if this component can be duplicated. Duplication means that we can expect to be able to make a complete copy of the component along with all it's external references. This method should return true if and only if CopyableComponent.getCopyReferences(java.util.List<artisynth.core.modelbase.ModelComponent>, artisynth.core.modelbase.ModelComponent) returns true.

This method is not currently used. It is intended to provide a faster way of determining if a component can be duplicated, without having to use CopyableComponent.getCopyReferences(java.util.List<artisynth.core.modelbase.ModelComponent>, artisynth.core.modelbase.ModelComponent) to build the list of copy references.

Specified by:

isDuplicatable in interface CopyableComponent

Returns:

true if this component can be duplicated.

isCloneable

public boolean isCloneable()

Overrides:

isCloneable in class NumericProbeBase

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException

Overrides:

clone in class NumericProbeBase

Throws:

java.lang.CloneNotSupportedException