artisynth.core.probes

Class NumericMonitorProbe

java.lang.Object

artisynth.core.modelbase.ModelComponentBase

artisynth.core.modelbase.ModelAgentBase

artisynth.core.probes.Probe

artisynth.core.probes.NumericProbeBase

artisynth.core.probes.NumericMonitorProbe

All Implemented Interfaces:

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

public class NumericMonitorProbe
extends NumericProbeBase
implements CopyableComponent

An output probe that generates data with an application-supplied generating function. Applications can supply this function by either

• Supplying a DataFunction to generate the data;
• Overriding the generateData(maspack.matrix.VectorNd, double, double) method;
• Overriding the apply(double) method.

Nested Class Summary

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

ModelComponent.NavpanelVisibility

Field Summary

Fields

Modifier and Type	Field and Description
static PropertyList	myProps

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

Constructor Summary

Constructors

Constructor and Description
NumericMonitorProbe()
NumericMonitorProbe(int vsize, double interval)
NumericMonitorProbe(int vsize, java.lang.String fileName, double startTime, double stopTime, double interval)

Method Summary

Modifier and Type	Method and Description
void	apply(double t) Called when the probe is being applied to a model
java.lang.Object	clone()
ModelComponent	copy(int flags, java.util.Map<ModelComponent,ModelComponent> copyMap) Create a copy of this component.
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).
void	generateData(VectorNd vec, double t, double trel) Generates data for this probe by evaluating a vectored-valued function of time and storing the result in vec.
PropertyList	getAllPropertyInfo() Returns a list giving static information about all properties exported by this object.
boolean	getCopyReferences(java.util.List<ModelComponent> refs, ModelComponent ancestor) Collects external references which must also be copied in order to duplicate this component.
DataFunction	getDataFunction() Returns the data function, if any, that is used by this probe's apply(double) method to generate data for this probe.
void	getInitialState(ComponentState newstate, ComponentState oldstate) Gets an initial state for this component and returns the value in state.
NumericList	getOutput()
boolean	getShowHeader()
boolean	getShowTime()
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	save() When called (perhaps by the Artsynth timeline), causes information about this probe to be written to its attached file.
void	scan(ReaderTokenizer rtok, java.lang.Object ref) Scans this element from a ReaderTokenizer.
boolean	scanItem(ReaderTokenizer rtok, java.util.Deque<ScanToken> tokens)
void	setAttachedFileName(java.lang.String fileName, java.lang.String fmtStr)
void	setAttachedFileName(java.lang.String fileName, java.lang.String fmtStr, boolean showTime, boolean showHeader)
void	setDataFunction(DataFunction func) Sets a data function to be used by this probe's generateData(maspack.matrix.VectorNd, double, double) method to generate data for this probe.
void	setShowHeader(boolean enable)
void	setShowTime(boolean enable)
void	setState(ComponentState state) Set the state of this component.
void	setVsize(int vsize)
void	setVsize(int vsize, PlotTraceInfo[] traceInfos)
void	write(java.io.PrintWriter pw, java.lang.String fmtStr, boolean showTime) Writes the start and stop times, scale value, and data for this probe to a PrintWriter, using the format described for NumericInputProbe.read(File).
void	writeData(java.io.PrintWriter pw, java.lang.String fmtStr, boolean showTime)
void	writeItems(java.io.PrintWriter pw, NumberFormat fmt, CompositeComponent ancestor) Write probe attributes to a PrintWriter

Methods inherited from class artisynth.core.probes.NumericProbeBase

applyDefaultDisplayRanges, createNumericList, decreaseDisplayRanges, dispose, getAttachedProperties, getData, getDefaultDisplayMax, getDefaultDisplayMin, getDefaultDisplayRange, getDisplay, getDrivers, getFormat, getInterpolation, getInterpolationOrder, getLegend, getMatlabName, getMinMaxValues, getNumericList, getOrderedTraceIndex, getPlotTraceInfo, getRange, getRangeHints, getTraceColor, getTraceLabel, getValues, getVariables, getVsize, increaseDisplayRanges, isEmpty, isPrintable, isSmallDisplayVisible, isTraceVisible, isValidVariableName, loadFromMatlab, print, removeDisplay, removeLegend, resetTraceColors, resetTraceOrder, saveToMatlab, scaleNumericList, setDefaultDisplayRange, setDefaultDisplayRange, setFormat, setInterpolation, setInterpolationOrder, setLegendLabels, setRangeHints, setScale, setSmallDisplayVisible, setTraceColor, setTraceLabel, setTraceOrder, setTraceVisible, setValues, swapPlotTraceOrder, updateDisplays, updateDisplays, updateDisplaysForPropertyChanges, updateDisplaysWithoutAutoRanging

Methods inherited from class artisynth.core.probes.Probe

getAttachedFile, getAttachedFileName, getChildren, getDefaultScale, getDefaultStartTime, getDefaultStopTime, getDefaultUpdateInterval, getDuration, getProperty, getScale, getStartTime, getStopTime, getTimelineTime, getTrack, getUpdateInterval, getVirtualTime, hasAttachedFile, hasChildren, isAttachedFileRelative, isEventTime, isInput, isScalable, isSettable, load, nextEventTime, setAttachedFileName, setData, 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, createTempFlag, disconnectFromHierarchy, getGrandParent, getHardReferences, getName, getNameRange, getNavpanelVisibility, getNavpanelVisibility, getNumber, getParent, getSoftReferences, isConnectedToHierarchy, isFixed, isMarked, isSelected, isWritable, makeValidName, makeValidName, notifyParentOfChange, postscan, printReferences, recursivelyContained, recursivelyContains, removeTempFlag, setFixed, setFlag, setMarked, setNavpanelVisibility, setNavpanelVisibility, setNumber, setParent, setSelected, updateReferences

Methods inherited from class java.lang.Object

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

Methods inherited from interface artisynth.core.modelbase.ModelComponent

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

Methods inherited from interface maspack.properties.HasProperties

getProperty

Methods inherited from interface maspack.properties.HierarchyNode

getChildren, hasChildren

Methods inherited from interface maspack.util.Scannable

isWritable, write

Field Detail

myProps

public static PropertyList myProps

Constructor Detail

NumericMonitorProbe

public NumericMonitorProbe()

NumericMonitorProbe

public NumericMonitorProbe(int vsize,
                           double interval)

NumericMonitorProbe

public NumericMonitorProbe(int vsize,
                           java.lang.String fileName,
                           double startTime,
                           double stopTime,
                           double interval)

Method Detail

getAllPropertyInfo

public PropertyList getAllPropertyInfo()

Description copied from interface: HasProperties

Returns a list giving static information about all properties exported by this object.

Specified by:

getAllPropertyInfo in interface HasProperties

Overrides:

getAllPropertyInfo in class NumericProbeBase

Returns:

static information for all exported properties

setDataFunction

public void setDataFunction(DataFunction func)

Sets a data function to be used by this probe's generateData(maspack.matrix.VectorNd, double, double) method to generate data for this probe. If the data function is set to null, then this probe's data is simply set to zero. If the generateData(maspack.matrix.VectorNd, double, double) method is overridden by a subclass, then the data generation 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 apply(double) method to generate data for this probe.

See Also:

setDataFunction(artisynth.core.probes.DataFunction)

getShowTime

public boolean getShowTime()

setShowTime

public void setShowTime(boolean enable)

getShowHeader

public boolean getShowHeader()

setShowHeader

public void setShowHeader(boolean enable)

write

public void write(java.io.PrintWriter pw,
                  java.lang.String fmtStr,
                  boolean showTime)
           throws java.io.IOException

Writes the start and stop times, scale value, and data for this probe to a PrintWriter, using the format described for NumericInputProbe.read(File). The format used for producing floating point numbers can be controlled using a printf-style format string, details of which are described in NumberFormat.

Parameters:

pw - writer which accepts the output

fmtStr - printf-style format string (if set to null then "%g" will be assumed, which will produce full precision output).

showTime - if true, then time values are written explicitly. Otherwise, an implicit step size corresponding to the value returned by getUpdateInterval will be specified.

Throws:

java.io.IOException - if an I/O error occurs.

setAttachedFileName

public void setAttachedFileName(java.lang.String fileName,
                                java.lang.String fmtStr)

setAttachedFileName

public void setAttachedFileName(java.lang.String fileName,
                                java.lang.String fmtStr,
                                boolean showTime,
                                boolean showHeader)

save

public void save()
          throws java.io.IOException

When called (perhaps by the Artsynth timeline), causes information about this probe to be written to its attached file.

Overrides:

save in class Probe

Throws:

java.io.IOException

See Also:

write(java.io.PrintWriter, java.lang.String, boolean)

writeData

public void writeData(java.io.PrintWriter pw,
                      java.lang.String fmtStr,
                      boolean showTime)

generateData

public void generateData(VectorNd vec,
                         double t,
                         double trel)

Generates data for this probe by evaluating a vectored-valued function of time and storing the result in vec. The size of vec will equal the vector size of the probe (as returned by NumericProbeBase.getVsize(). The function may generate the data using either absolute time t or relative time trel, where relative time is determined from the probe's start time and scale factor using

 trel = (t - startTime)/scale 

Parameters:

vec - returns the generated data.

t - absolute time (seconds)

trel - probe relative time

apply

public void apply(double t)

Description copied from class: Probe

Called when the probe is being applied to a model

Specified by:

apply in class NumericProbeBase

clone

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

Overrides:

clone in class NumericProbeBase

Throws:

java.lang.CloneNotSupportedException

getOutput

public NumericList getOutput()

scanItem

public boolean scanItem(ReaderTokenizer rtok,
                        java.util.Deque<ScanToken> tokens)
                 throws java.io.IOException

Throws:

java.io.IOException

scan

public void scan(ReaderTokenizer rtok,
                 java.lang.Object ref)
          throws java.io.IOException

Description copied from class: ModelComponentBase

Scans this element from a ReaderTokenizer. The expected text format is assumed to be compatible with that produced by write.

Specified by:

scan in interface ModelComponent

Specified by:

scan in interface Scannable

Overrides:

scan in class Probe

Parameters:

rtok - Tokenizer from which to scan the element

ref - optional reference object which can be used for resolving references to other objects

Throws:

java.io.IOException - if an I/O or formatting error occured

writeItems

public void writeItems(java.io.PrintWriter pw,
                       NumberFormat fmt,
                       CompositeComponent ancestor)
                throws java.io.IOException

Description copied from class: Probe

Write probe attributes to a PrintWriter

Parameters:

pw - writer to which components are written

fmt - format for floating point numbers

ancestor - ancestor component which respect to which references are expressed

Throws:

java.io.IOException - if an I/O error occurred

setVsize

public void setVsize(int vsize)

setVsize

public void setVsize(int vsize,
                     PlotTraceInfo[] traceInfos)

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) sub-components.

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

getCopyReferences

public boolean getCopyReferences(java.util.List<ModelComponent> refs,
                                 ModelComponent ancestor)

Collects external references which must also be copied in order to duplicate this component. These references should exclude those which are contained within a specified component hierarchy. This method should return true if and only if CopyableComponent.isDuplicatable() returns true.

Specified by:

getCopyReferences in interface CopyableComponent

Parameters:

refs - list to which references are appended

ancestor - root node of the hierarchy from which references are to be excluded

Returns:

false if it is discovered that the component cannot be duplicated

copy

public ModelComponent copy(int flags,
                           java.util.Map<ModelComponent,ModelComponent> copyMap)

Description copied from interface: CopyableComponent

Create a copy of this component. If COPY_REFERENCES is set in flags, then any component referenced by this component should itself be set to a copy. This should be done first checking copyMap for an existing copy of the referenced component. If there is no existing copy, then a copy should be created by calling copy recursively and adding the new copy to copyMap.

Specified by:

copy in interface CopyableComponent

Overrides:

copy in class ModelComponentBase

Parameters:

flags - flags to control the copying

copyMap - map to possible existing instances of referenced components

Returns:

copy of this component