artisynth.core.modelbase

Class NumericState

java.lang.Object

maspack.util.DataBuffer

artisynth.core.modelbase.NumericState

All Implemented Interfaces:

ComponentState, java.io.Serializable, Scannable

Direct Known Subclasses:

MechModelState

public class NumericState
extends DataBuffer
implements ComponentState

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	NumericState.DataFrame Used to delimit the state associated with a particular component, for both diagnostic purposes and for properly restoring component states within HasState.getInitialState(artisynth.core.modelbase.ComponentState, artisynth.core.modelbase.ComponentState).

Nested classes/interfaces inherited from class maspack.util.DataBuffer

DataBuffer.Offsets

Constructor Summary

Constructors

Constructor and Description
NumericState()
NumericState(boolean annotated)
NumericState(int zcap, int dcap)
NumericState(int zcap, int dcap, int ocap)

Method Summary

Modifier and Type	Method and Description
void	addDataFrame(HasNumericState comp)
int	byteSize()
void	clear()
ComponentState	duplicate() Create a duplicate of this state which can be used for storing this state's values.
boolean	equals(ComponentState state, java.lang.StringBuilder msg) Returns true if this state equals another component state.
boolean	equals(NumericState state, java.lang.StringBuilder errMsg)
NumericState.DataFrame	getDataFrame(int idx)
void	getState(HasNumericState comp)
void	getState(NumericState.DataFrame frame, NumericState state)
boolean	hasDataFrames()
boolean	isAnnotated() Queries whether or not this state is annotated.
boolean	isWritable() Returns true if this component should in fact be written to secondary storage.
int	numDataFrames()
void	print()
void	readBinary(java.io.DataInputStream dis) Read this state (in binary format) from a data input stream.
void	scan(ReaderTokenizer rtok, java.lang.Object ref) Scans this element from a ReaderTokenizer.
void	set(ComponentState state) Sets this state by copying the value from an existing state object.
void	set(NumericState state)
void	setAnnotated(boolean annotated) Requests that this state be annotated.
void	setHasDataFrames(boolean hasFrames)
java.lang.String	toString()
void	write(java.io.PrintWriter pw, NumberFormat fmt, java.lang.Object ref) Writes a text description of this element to a PrintWriter.
void	writeBinary(java.io.DataOutputStream dos) Writes this state (in binary format) to a data output stream.

Methods inherited from class maspack.util.DataBuffer

dbuffer, dEnsureCapacity, dequals, dget, dget, dget, dget, dget, doffset, dpeek, dpeek, dput, dput, dput, dput, dput, dset, dsetOffset, dsetSize, dsize, dskip, equals, getNumericOffsets, getNumericSizes, getOffsets, getSizes, numericEquals, obuffer, oEnsureCapacity, oequals, oget, ooffset, opeek, opeek, oput, oputs, oset, osetOffset, osetSize, osize, oskip, resetOffsets, set, zbuffer, zEnsureCapacity, zequals, zget, zgetBool, zoffset, zpeek, zpeek, zput, zputBool, zset, zsetOffset, zsetSize, zsize, zskip

Methods inherited from class java.lang.Object

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

Methods inherited from interface artisynth.core.modelbase.ComponentState

equals

Constructor Detail

NumericState

public NumericState()

NumericState

public NumericState(boolean annotated)

NumericState

public NumericState(int zcap,
                    int dcap)

NumericState

public NumericState(int zcap,
                    int dcap,
                    int ocap)

Method Detail

hasDataFrames

public boolean hasDataFrames()

setHasDataFrames

public void setHasDataFrames(boolean hasFrames)

numDataFrames

public int numDataFrames()

getDataFrame

public NumericState.DataFrame getDataFrame(int idx)

addDataFrame

public void addDataFrame(HasNumericState comp)

getState

public void getState(HasNumericState comp)

getState

public void getState(NumericState.DataFrame frame,
                     NumericState state)

set

public void set(NumericState state)

writeBinary

public void writeBinary(java.io.DataOutputStream dos)
                 throws java.io.IOException

Description copied from interface: ComponentState

Writes this state (in binary format) to a data output stream.

Specified by:

writeBinary in interface ComponentState

Parameters:

dos - output stream to write model to

Throws:

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

readBinary

public void readBinary(java.io.DataInputStream dis)
                throws java.io.IOException

Description copied from interface: ComponentState

Read this state (in binary format) from a data input stream.

Specified by:

readBinary in interface ComponentState

Parameters:

dis - input stream to read model from

Throws:

java.io.IOException - if an I/O error occurred or if the input is incompatible with the current state configuration.

isWritable

public boolean isWritable()

Description copied from interface: Scannable

Returns true if this component should in fact be written to secondary storage. This gives subclasses control over whether or not they are actually written out.

Specified by:

isWritable in interface Scannable

Returns:

true if this component should be written to secondary storage.

write

public void write(java.io.PrintWriter pw,
                  NumberFormat fmt,
                  java.lang.Object ref)
           throws java.io.IOException

Description copied from interface: Scannable

Writes a text description of this element to a PrintWriter. The text description should be compatable with scan and complete enough to allow full reconstruction of the element.

Specified by:

write in interface Scannable

Parameters:

pw - stream for writing the element

fmt - numeric formating information

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

Throws:

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

scan

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

Description copied from interface: Scannable

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 Scannable

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

set

public void set(ComponentState state)

Description copied from interface: ComponentState

Sets this state by copying the value from an existing state object.

Specified by:

set in interface ComponentState

Parameters:

state - state object to copy

equals

public boolean equals(ComponentState state,
                      java.lang.StringBuilder msg)

Returns true if this state equals another component state.

Specified by:

equals in interface ComponentState

Parameters:

state - state to compare to

msg - If not null, can be used to append diagnostic information if the states are not equal.

equals

public boolean equals(NumericState state,
                      java.lang.StringBuilder errMsg)

clear

public void clear()

Overrides:

clear in class DataBuffer

duplicate

public ComponentState duplicate()

Description copied from interface: ComponentState

Create a duplicate of this state which can be used for storing this state's values.

Specified by:

duplicate in interface ComponentState

Returns:

duplicate of this state

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

byteSize

public int byteSize()

isAnnotated

public boolean isAnnotated()

Queries whether or not this state is annotated. Annotation means that the state may contain additional information about its contents. In particular, this can be used to give details about how two states differ (via the msg argument to equals(state,msg). For NumericState, annotation is equivalent to hasFrames() == true.

Specified by:

isAnnotated in interface ComponentState

Returns:

true if this state is annotated.

setAnnotated

public void setAnnotated(boolean annotated)

Requests that this state be annotated. See isAnnotated() for more details.

Annotation is supported by frames. If annotation is true, frames are enabled. Otherwise, this method has no effect.

Specified by:

setAnnotated in interface ComponentState

Parameters:

annotated - if true, enables frame for this state.

print

public void print()