artisynth.core.opensim.components

Class ModelComponentMap

java.lang.Object

artisynth.core.opensim.components.ModelComponentMap

All Implemented Interfaces:

java.util.Map<OpenSimObject,ModelComponent>

public class ModelComponentMap
extends java.lang.Object
implements java.util.Map<OpenSimObject,ModelComponent>

Helper class for relating OpenSimObjects to ArtiSynth ModelComponents, for use in building models

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

java.util.Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
ModelComponentMap()

Method Summary

Modifier and Type	Method and Description
void	clear()
boolean	containsKey(java.lang.Object key)
boolean	containsValue(java.lang.Object value)
java.util.Set<java.util.Map.Entry<OpenSimObject,ModelComponent>>	entrySet()
<O extends OpenSimObject> O	findObjectByName(java.lang.Class<O> baseClass, java.lang.String name) Finds the first instance of an object assignable to baseClass with the provided name
OpenSimObject	findObjectByName(java.lang.String name) Finds the first instance of an object with the provided name
OpenSimObject	findObjectByPath(OpenSimObject obj, java.lang.String path) Returns a component by its fully qualified path
<O extends OpenSimObject> O	findObjectByPathOrName(java.lang.Class<O> baseClass, OpenSimObject ref, java.lang.String pathOrName) Finds the first instance of an object assignable to baseClass with the provided path or name
ModelComponent	get(java.lang.Object key)
ModelComponent	get(OpenSimObject obj) Gets a model component by OpenSimObject
BodySet	getBodySet() Returns the body set, if present
JointSet	getJointSet() Returns the joint set, if present
boolean	isEmpty()
java.util.Set<OpenSimObject>	keySet()
ModelComponent	put(OpenSimObject obj, ModelComponent comp) Adds the component to the map
void	putAll(java.util.Map<? extends OpenSimObject,? extends ModelComponent> m)
ModelComponent	remove(java.lang.Object key)
java.util.HashMap<ModelComponent,OpenSimObject>	reverseMap()
int	size()
java.util.Collection<ModelComponent>	values()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, equals, forEach, getOrDefault, hashCode, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

ModelComponentMap

public ModelComponentMap()

Method Detail

findObjectByName

public <O extends OpenSimObject> O findObjectByName(java.lang.Class<O> baseClass,
                                                    java.lang.String name)

Finds the first instance of an object assignable to baseClass with the provided name

Parameters:

baseClass - base class for type conversion

name - object name

Returns:

object if found, null otherwise

findObjectByPathOrName

public <O extends OpenSimObject> O findObjectByPathOrName(java.lang.Class<O> baseClass,
                                                          OpenSimObject ref,
                                                          java.lang.String pathOrName)

Finds the first instance of an object assignable to baseClass with the provided path or name

Parameters:

baseClass - base class for type conversion

ref - reference object for resolving relative paths

pathOrName - object path or name

Returns:

object if found, null otherwise

findObjectByName

public OpenSimObject findObjectByName(java.lang.String name)

Finds the first instance of an object with the provided name

Parameters:

name - object name

Returns:

object if found, null otherwise

findObjectByPath

public OpenSimObject findObjectByPath(OpenSimObject obj,
                                      java.lang.String path)

Returns a component by its fully qualified path

Parameters:

obj - object from which path is requested (for relative path resolution)

path - absolute or relative path

Returns:

component at path if exists

put

public ModelComponent put(OpenSimObject obj,
                          ModelComponent comp)

Adds the component to the map

Specified by:

put in interface java.util.Map<OpenSimObject,ModelComponent>

Parameters:

obj - OpenSimObject

comp - corresponding ModelComponent

get

public ModelComponent get(OpenSimObject obj)

Gets a model component by OpenSimObject

Parameters:

obj - object

Returns:

corresponding model component if it exists

getJointSet

public JointSet getJointSet()

Returns the joint set, if present

getBodySet

public BodySet getBodySet()

Returns the body set, if present

size

public int size()

Specified by:

size in interface java.util.Map<OpenSimObject,ModelComponent>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface java.util.Map<OpenSimObject,ModelComponent>

containsKey

public boolean containsKey(java.lang.Object key)

Specified by:

containsKey in interface java.util.Map<OpenSimObject,ModelComponent>

containsValue

public boolean containsValue(java.lang.Object value)

Specified by:

containsValue in interface java.util.Map<OpenSimObject,ModelComponent>

get

public ModelComponent get(java.lang.Object key)

Specified by:

get in interface java.util.Map<OpenSimObject,ModelComponent>

remove

public ModelComponent remove(java.lang.Object key)

Specified by:

remove in interface java.util.Map<OpenSimObject,ModelComponent>

putAll

public void putAll(java.util.Map<? extends OpenSimObject,? extends ModelComponent> m)

Specified by:

putAll in interface java.util.Map<OpenSimObject,ModelComponent>

clear

public void clear()

Specified by:

clear in interface java.util.Map<OpenSimObject,ModelComponent>

keySet

public java.util.Set<OpenSimObject> keySet()

Specified by:

keySet in interface java.util.Map<OpenSimObject,ModelComponent>

values

public java.util.Collection<ModelComponent> values()

Specified by:

values in interface java.util.Map<OpenSimObject,ModelComponent>

entrySet

public java.util.Set<java.util.Map.Entry<OpenSimObject,ModelComponent>> entrySet()

Specified by:

entrySet in interface java.util.Map<OpenSimObject,ModelComponent>

reverseMap

public java.util.HashMap<ModelComponent,OpenSimObject> reverseMap()