artisynth.core.probes

Class Probe

java.lang.Object

artisynth.core.modelbase.ModelComponentBase

artisynth.core.modelbase.ModelAgentBase

artisynth.core.probes.Probe

All Implemented Interfaces:

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

Direct Known Subclasses:

InputProbe, NumericProbeBase, OutputProbe

public abstract class Probe
extends ModelAgentBase

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Probe.ExportProps
static class	Probe.ImportExportFileInfo Contains information about the types of files this probe can be exported or imported to.

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

ModelComponent.NavpanelVisibility

Field Summary

Fields

Modifier and Type	Field and Description
static PropertyList	myProps
static boolean	useOldSaveMethod
static boolean	writeStartStopTimeInSeconds

Fields inherited from class artisynth.core.modelbase.ModelComponentBase

enforceUniqueCompositeNames, enforceUniqueNames, myNumber, NULL_OBJ, useCompactPathNames

Constructor Summary

Constructors

Constructor and Description
Probe()

Method Summary

Modifier and Type	Method and Description
abstract void	apply(double t) Called at time t to apply this probe
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	export(java.io.File file, Probe.ExportProps props)
PropertyList	getAllPropertyInfo() Returns a list giving static information about all properties exported by this object.
java.io.File	getAttachedFile()
java.lang.String	getAttachedFileName()
java.util.Iterator<? extends HierarchyNode>	getChildren()
double	getClippedVirtualTime(double sec)
static double	getDefaultScale()
static double	getDefaultStartTime()
static double	getDefaultStopTime()
static double	getDefaultUpdateInterval()
double	getDuration()
java.io.File	getExportFile()
Probe.ImportExportFileInfo[]	getExportFileInfo()
java.lang.String	getExportFileName()
Probe.ExportProps	getExportProps(java.lang.String ext)
static java.io.File	getFileFromPath(java.lang.String fileName)
java.io.File	getImportFile()
Probe.ImportExportFileInfo[]	getImportFileInfo()
java.lang.String	getImportFileName()
void	getInitialState(ComponentState newstate, ComponentState oldstate) Gets an initial state for this component and returns the value in state.
static java.lang.String	getPathFromFile(java.io.File file) Returns the path for a file.
Property	getProperty(java.lang.String name) Returns a property associated with a specified path name.
double	getScale()
double	getStartTime()
void	getState(ComponentState state) Get the current state of this component.
double	getStopTime()
double	getTimelineTime(double t)
java.lang.Integer	getTrack() Returns the Timeline track number associated with this probe.
double	getUpdateInterval()
double	getVirtualTime(double sec)
boolean	hasAttachedFile()
boolean	hasChildren()
boolean	hasState() Queries if this component has state.
void	importData(java.io.File file, boolean explicitTime, boolean overlay) Still being implemented
boolean	isAttachedFileRelative()
boolean	isCloneable()
boolean	isEventTime(double t) Queries whether time t is an event time for this probe.
boolean	isInput() Returns true if this probe is an input probe, and false otherwise.
boolean	isPrintable()
boolean	isScalable()
boolean	isSettable()
void	load()
double	nextEventTime(double t) Returns the time of the next probe event after time t.
void	print(double sec)
void	save()
void	scan(ReaderTokenizer rtok, java.lang.Object ref) Scans this element from a ReaderTokenizer.
void	setAttachedFileName(java.lang.String fileName)
void	setData(double sec)
void	setExportFileName(java.lang.String fileName)
void	setImportFileName(java.lang.String fileName)
void	setInterval(double startTime, double stopTime)
void	setName(java.lang.String name) Sets the name of this component.
void	setScalable(boolean enable)
void	setScale(double s)
void	setStartStopTimes(double startTime, double stopTime)
void	setStartTime(double t)
void	setState(ComponentState state) Set the state of this component.
void	setStopTime(double t)
void	setTrack(int num) Sets the Timeline track number associated with this probe.
void	setUpdateInterval(double t)

Methods inherited from class artisynth.core.modelbase.ModelAgentBase

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

Methods inherited from class artisynth.core.modelbase.ModelComponentBase

checkFlag, checkName, checkNameUniqueness, clearFlag, clone, connectToHierarchy, copy, createTempFlag, disconnectFromHierarchy, getGrandParent, getHardReferences, getName, getNameRange, getNavpanelVisibility, getNavpanelVisibility, getNumber, getParent, getSoftReferences, isFixed, isMarked, isScanning, isSelected, isWritable, 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.ModelComponent

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

Methods inherited from interface artisynth.core.modelbase.PostScannable

postscan

Methods inherited from interface maspack.util.Scannable

isWritable

Field Detail

useOldSaveMethod

public static boolean useOldSaveMethod

writeStartStopTimeInSeconds

public static boolean writeStartStopTimeInSeconds

myProps

public static PropertyList myProps

Constructor Detail

Probe

public Probe()

Method Detail

getExportFileName

public java.lang.String getExportFileName()

getExportFile

public java.io.File getExportFile()

setExportFileName

public void setExportFileName(java.lang.String fileName)

getImportFileName

public java.lang.String getImportFileName()

getImportFile

public java.io.File getImportFile()

setImportFileName

public void setImportFileName(java.lang.String fileName)

getExportProps

public Probe.ExportProps getExportProps(java.lang.String ext)

getExportFileInfo

public Probe.ImportExportFileInfo[] getExportFileInfo()

getImportFileInfo

public Probe.ImportExportFileInfo[] getImportFileInfo()

export

public void export(java.io.File file,
                   Probe.ExportProps props)
            throws java.io.IOException

Throws:

java.io.IOException

importData

public void importData(java.io.File file,
                       boolean explicitTime,
                       boolean overlay)
                throws java.io.IOException

Still being implemented

Throws:

java.io.IOException

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 ModelAgentBase

Returns:

static information for all exported properties

getDefaultStartTime

public static double getDefaultStartTime()

getDefaultStopTime

public static double getDefaultStopTime()

getDefaultScale

public static double getDefaultScale()

getDefaultUpdateInterval

public static double getDefaultUpdateInterval()

getProperty

public Property getProperty(java.lang.String name)

Description copied from class: ModelComponentBase

Returns a property associated with a specified path name. All properties exported by this object must have a name which is a valid Java identifier. Specifying one of these names causes the corresponding Property to be returned. Handles to subproperties can also be obtained by delimiting the sub-property name(s) by '.' characters. A sub-property exists if the value of a property is itself an object which exports properties. It is only possible to obtain a sub-property handle if each of its ancestor properties exports their values by reference.

Specified by:

getProperty in interface HasProperties

Overrides:

getProperty in class ModelComponentBase

Parameters:

name - name of the desired property or sub-property

Returns:

handle to the property

getStartTime

public double getStartTime()

setStartTime

public void setStartTime(double t)

getStopTime

public double getStopTime()

setStopTime

public void setStopTime(double t)

getDuration

public double getDuration()

setInterval

public void setInterval(double startTime,
                        double stopTime)

setStartStopTimes

public void setStartStopTimes(double startTime,
                              double stopTime)

getScale

public double getScale()

setScale

public void setScale(double s)

setScalable

public void setScalable(boolean enable)

isScalable

public boolean isScalable()

getUpdateInterval

public double getUpdateInterval()

setUpdateInterval

public void setUpdateInterval(double t)

setName

public void setName(java.lang.String name)

Sets the name of this component. When the name is set, this method should call notifyParentOfChange with a NameChangeEvent so that it's parent can update the name map entry and other ancestors can adjust for the new name.

Component names can be specified as null. However, if not null, they should have non-zero length and should not begin with a digit or contain the characters '.' or '/'. Implementations can use ModelComponentBase.checkName() to determine if a proposed name is valid.

Specified by:

setName in interface ModelComponent

Overrides:

setName in class ModelComponentBase

Parameters:

name - new component name

hasChildren

public boolean hasChildren()

Specified by:

hasChildren in interface HierarchyNode

Overrides:

hasChildren in class ModelComponentBase

getChildren

public java.util.Iterator<? extends HierarchyNode> getChildren()

Specified by:

getChildren in interface HierarchyNode

Overrides:

getChildren in class ModelComponentBase

isEventTime

public boolean isEventTime(double t)

Queries whether time t is an event time for this probe.

Parameters:

t - time to query

Returns:

true if t is an event time

nextEventTime

public double nextEventTime(double t)

Returns the time of the next probe event after time t.

Parameters:

t - reference time for the next event

Returns:

time of next probe event after t

apply

public abstract void apply(double t)

Called at time t to apply this probe

Parameters:

t - time at which probe is being applied

isCloneable

public boolean isCloneable()

save

public void save()
          throws java.io.IOException

Throws:

java.io.IOException

load

public void load()
          throws java.io.IOException

Throws:

java.io.IOException

getVirtualTime

public double getVirtualTime(double sec)

getClippedVirtualTime

public double getClippedVirtualTime(double sec)

getTimelineTime

public double getTimelineTime(double t)

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 ModelComponentBase

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

isAttachedFileRelative

public boolean isAttachedFileRelative()

getFileFromPath

public static java.io.File getFileFromPath(java.lang.String fileName)

getPathFromFile

public static java.lang.String getPathFromFile(java.io.File file)

Returns the path for a file. If the file is located beneath the default location for probe files, the path will be relative to that location. Otherwise, it will be absolute. At present, the 'default' location is simply the current ArtiSynth working directory.

getAttachedFile

public java.io.File getAttachedFile()

setAttachedFileName

public void setAttachedFileName(java.lang.String fileName)

getAttachedFileName

public java.lang.String getAttachedFileName()

hasAttachedFile

public boolean hasAttachedFile()

setTrack

public void setTrack(int num)

Sets the Timeline track number associated with this probe. The Timeline should use this method to keep the track information current.

Parameters:

num - new track number

getTrack

public java.lang.Integer getTrack()

Returns the Timeline track number associated with this probe.

Returns:

timeline track number

isInput

public boolean isInput()

Returns true if this probe is an input probe, and false otherwise.

Returns:

true if this is an input probe

isSettable

public boolean isSettable()

setData

public void setData(double sec)

isPrintable

public boolean isPrintable()

print

public void print(double sec)

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 ModelComponentBase

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.

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.

Parameters:

state - receives the state information

setState

public void setState(ComponentState state)

Description copied from interface: HasState

Set the state of this component.

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.

Parameters:

newstate - receives the state information

oldstate - previous state information; may be null.