artisynth.core.probes

Class VelocityOutputProbe

java.lang.Object

artisynth.core.modelbase.ModelComponentBase

artisynth.core.modelbase.ModelAgentBase

artisynth.core.probes.Probe

artisynth.core.probes.NumericProbeBase

artisynth.core.probes.NumericOutputProbe

artisynth.core.probes.VelocityOutputProbe

All Implemented Interfaces:

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

public class VelocityOutputProbe
extends NumericOutputProbe

Probe for recording the velocities of a set of Point, Frame, and FixedMeshBody components. Velocity information is read from each components's velocity property and is specified in world coordinates. For components with orientation (Frame and FixedMeshBody), the velocity will be a 6-vector (Twist) giving both translational and angular velocity.

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.NumericOutputProbe

myProps

Fields inherited from class artisynth.core.probes.NumericProbeBase

EXPLICIT_TIME, 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
VelocityOutputProbe() No-args constructor needed for scanning.
VelocityOutputProbe(java.lang.String name, java.util.Collection<? extends ModelComponent> comps, double startTime, double stopTime) Constructs a VelocityOutputProbe for a list of Point, Frame, or FixedMeshBody components specified by comps.
VelocityOutputProbe(java.lang.String name, java.util.Collection<? extends ModelComponent> comps, java.lang.String fileName, double startTime, double stopTime, double interval) Constructs a VelocityOutputProbe for a list of Point, Frame, or FixedMeshBody components specified by comps.
VelocityOutputProbe(java.lang.String name, ModelComponent comp, double startTime, double stopTime) Constructs a VelocityOutputProbe for a single Point, Frame, or FixedMeshBody, as specified by comp.
VelocityOutputProbe(java.lang.String name, ModelComponent comp, java.lang.String fileName, double startTime, double stopTime, double interval) Constructs a VelocityOutputProbe for a single Point, Frame, or FixedMeshBody, as specified by comp.

Method Summary

Methods inherited from class artisynth.core.probes.NumericOutputProbe

apply, clone, copy, getAllPropertyInfo, getCopyReferences, getOutput, getShowHeader, getShowTime, isDuplicatable, isEditable, load, postscan, save, scan, scanItem, set, set, setAttachedFileName, setAttachedFileName, setOutputProperties, setShowHeader, setShowTime, write, writeData, writeItems

Methods inherited from class artisynth.core.probes.NumericProbeBase

addData, applyDefaultDisplayRanges, clearData, decreaseDisplayRanges, dispose, export, getAttachedProperties, getData, getDefaultDisplayMax, getDefaultDisplayMin, getDefaultDisplayRange, getDisplay, getDrivers, getExportFileInfo, getExportProps, getFormat, getInterpolation, getInterpolationOrder, getLegend, getMatlabName, getMinMaxValues, getNumericList, getOrderedTraceIndex, getPlotTraceInfo, getRotationRep, getRotationSubvecOffsets, getTraceColor, getTraceLabel, getTraceManager, getValues, getVariables, getVisibleMinMaxValues, getVisibleRange, getVisibleRange, getVsize, importData, importText, increaseDisplayRanges, isCloneable, 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, setValues, smoothWithMovingAverage, smoothWithSavitzkyGolay, swapPlotTraceOrder, updateDisplays, updateDisplays, updateDisplaysForPropertyChanges, updateDisplaysWithoutAutoRanging, writeText

Methods inherited from class artisynth.core.probes.Probe

createState, getAttachedFile, getAttachedFileName, getChildren, getClippedVirtualTime, getDefaultScale, getDefaultStartTime, getDefaultStopTime, getDefaultUpdateInterval, getDuration, getExportFile, getExportFileName, getFileFromPath, getImportFile, getImportFileInfo, getImportFileName, getInitialState, getPathFromFile, getProperty, getScale, getStartTime, getState, getStopTime, getTimelineTime, getTrack, getUpdateInterval, getVirtualTime, hasAttachedFile, hasChildren, hasState, isAttachedFileRelative, isEventTime, isInput, isScalable, isSettable, nextEventTime, setAttachedFileName, setData, setExportFileName, setImportFileName, setInterval, setName, setScalable, setStartStopTimes, setStartTime, setState, 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, isFixed, isMarked, isScanning, isSelected, makeValidName, makeValidName, notifyParentOfChange, 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.ModelComponent

connectToHierarchy, disconnectFromHierarchy, getHardReferences, getName, getNavpanelVisibility, getNumber, getParent, getSoftReferences, hasState, isFixed, isMarked, isSelected, notifyParentOfChange, setFixed, setMarked, setName, setNumber, setParent, setSelected, setWritable, 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

Constructor Detail

VelocityOutputProbe

public VelocityOutputProbe()

No-args constructor needed for scanning.

VelocityOutputProbe

public VelocityOutputProbe(java.lang.String name,
                           ModelComponent comp,
                           double startTime,
                           double stopTime)

Constructs a VelocityOutputProbe for a single Point, Frame, or FixedMeshBody, as specified by comp. The update interval is set to [-1, meaning that updates will occur every simulation step.

Parameters:

name - if non-null, gives the name of the probe

comp - specifies the Point, Frame, or FixedMeshBody

startTime - start time of the probe

stopTime - stop time of the probe

VelocityOutputProbe

public VelocityOutputProbe(java.lang.String name,
                           java.util.Collection<? extends ModelComponent> comps,
                           double startTime,
                           double stopTime)

Constructs a VelocityOutputProbe for a list of Point, Frame, or FixedMeshBody components specified by comps. The update interval is set to [-1, meaning that updates will occur every simulation step.

Parameters:

name - if non-null, gives the name of the probe

comps - specifies the Point, Frame, or FixedMeshBody components

startTime - start time of the probe

stopTime - stop time of the probe

VelocityOutputProbe

public VelocityOutputProbe(java.lang.String name,
                           ModelComponent comp,
                           java.lang.String fileName,
                           double startTime,
                           double stopTime,
                           double interval)

Constructs a VelocityOutputProbe for a single Point, Frame, or FixedMeshBody, as specified by comp.

Parameters:

name - if non-null, gives the name of the probe

comp - specifies the Point, Frame, or FixedMeshBody

fileName - if non-null, specifies the attached file to which probe data can be saved

startTime - start time of the probe

stopTime - stop time of the probe

interval - probe update interval. If set to -1, updates will occur every simulation step.

VelocityOutputProbe

public VelocityOutputProbe(java.lang.String name,
                           java.util.Collection<? extends ModelComponent> comps,
                           java.lang.String fileName,
                           double startTime,
                           double stopTime,
                           double interval)

Constructs a VelocityOutputProbe for a list of Point, Frame, or FixedMeshBody components specified by comps.

Parameters:

name - if non-null, gives the name of the probe

comps - specifies the Point, Frame, or FixedMeshBody components

fileName - if non-null, specifies the attached file to which probe data can be saved

startTime - start time of the probe

stopTime - stop time of the probe

interval - probe update interval. If set to -1, updates will occur every simulation step.