artisynth.core.inverse

Class ExciterComp

java.lang.Object

artisynth.core.modelbase.ModelComponentBase

artisynth.core.modelbase.ReferenceComp<C>

artisynth.core.modelbase.WeightedReferenceComp<ExcitationComponent>

artisynth.core.inverse.ExciterComp

All Implemented Interfaces:

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

public class ExciterComp
extends WeightedReferenceComp<ExcitationComponent>

Wrapper component used to store the excitation components used by the inverse solver. Contains the upper and lower excitation bounds.

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.modelbase.WeightedReferenceComp

DEFAULT_WEIGHT

Fields inherited from class artisynth.core.modelbase.ModelComponentBase

enforceUniqueCompositeNames, enforceUniqueNames, myNumber, NULL_OBJ, useCompactPathNames

Constructor Summary

Constructors

Constructor and Description
ExciterComp()
ExciterComp(ExcitationComponent ex, double weight)

Method Summary

Modifier and Type	Method and Description
PropertyList	getAllPropertyInfo() Returns a list giving static information about all properties exported by this object.
double	getExcitation()
DoubleInterval	getExcitationBounds()
PropertyMode	getExcitationBoundsMode()
ExcitationComponent	getExciter()
void	setExcitation(double e)
void	setExcitationBounds(DoubleInterval bounds)
void	setExcitationBoundsMode(PropertyMode mode)

Methods inherited from class artisynth.core.modelbase.WeightedReferenceComp

getWeight, setWeight

Methods inherited from class artisynth.core.modelbase.ReferenceComp

getHardReferences, getReference, scanItem, setReference, writeItems

Methods inherited from class artisynth.core.modelbase.ModelComponentBase

checkFlag, checkName, checkNameUniqueness, clearFlag, clone, connectToHierarchy, copy, createTempFlag, disconnectFromHierarchy, getChildren, getGrandParent, getName, getNameRange, getNavpanelVisibility, getNavpanelVisibility, getNumber, getParent, getProperty, getSoftReferences, hasChildren, hasState, isFixed, isMarked, isScanning, isSelected, isWritable, makeValidName, makeValidName, notifyParentOfChange, postscan, printReferences, recursivelyContained, recursivelyContains, removeTempFlag, scan, setFixed, setFlag, setMarked, setName, setNavpanelVisibility, setNavpanelVisibility, setNumber, setParent, setScanning, setSelected, setWritable, updateReferences, write

Methods inherited from class java.lang.Object

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

Field Detail

myProps

public static PropertyList myProps

Constructor Detail

ExciterComp

public ExciterComp()

ExciterComp

public ExciterComp(ExcitationComponent ex,
                   double weight)

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 WeightedReferenceComp<ExcitationComponent>

Returns:

static information for all exported properties

getExcitationBounds

public DoubleInterval getExcitationBounds()

setExcitationBounds

public void setExcitationBounds(DoubleInterval bounds)

getExcitationBoundsMode

public PropertyMode getExcitationBoundsMode()

setExcitationBoundsMode

public void setExcitationBoundsMode(PropertyMode mode)

getExciter

public ExcitationComponent getExciter()

setExcitation

public void setExcitation(double e)

getExcitation

public double getExcitation()