artisynth.core.modelbase

Interface ComponentState

All Superinterfaces:

Scannable, java.io.Serializable

All Known Implementing Classes:

CompositeState, EmptyState, MechModelState, NumericState

public interface ComponentState
extends java.io.Serializable, Scannable

Object containing state information for an Artisynth model or component.

Method Summary

Modifier and Type	Method and Description
ComponentState	duplicate() Create a duplicate of this state which can be used for storing this state's values.
default boolean	equals(ComponentState state) Returns true if this state equals another component state.
boolean	equals(ComponentState state, java.lang.StringBuilder msg) Returns true if this state equals another component state.
default boolean	isAnnotated() Queries whether or not this state is annotated.
void	readBinary(java.io.DataInputStream dis) Read this state (in binary format) from a data input stream.
void	set(ComponentState state) Sets this state by copying the value from an existing state object.
default void	setAnnotated(boolean annotated) Requests that this state be annotated.
void	writeBinary(java.io.DataOutputStream dos) Writes this state (in binary format) to a data output stream.

Methods inherited from interface maspack.util.Scannable

isWritable, scan, write

Method Detail

writeBinary

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

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

Parameters:

dos - output stream to write model to

Throws:

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

readBinary

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

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

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.

set

void set(ComponentState state)

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

Parameters:

state - state object to copy

Throws:

java.lang.IllegalArgumentException - if the state objects are incompatible

equals

default boolean equals(ComponentState state)

Returns true if this state equals another component state.

Parameters:

state - state to compare to

equals

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

Returns true if this state equals another component state.

Parameters:

state - state to compare to

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

isAnnotated

default 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).

Returns:

true if this state is annotated.

setAnnotated

default void setAnnotated(boolean annotated)

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

Support for this method is optional. Applications should check isAnnotated() to determine if the request has been honored.

Parameters:

annotated - if true, requests that this state be annotated.

duplicate

ComponentState duplicate()

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

Returns:

duplicate of this state