hep.graphics.heprep
Interface HepRepInstanceTree

All Superinterfaces:
HepRepTreeID

public interface HepRepInstanceTree
extends HepRepTreeID

HepRepInstanceTree interface.

Author:
Mark Donszelmann

Method Summary
 void addInstance(HepRepInstance instance)
          Adds an instance to this instancetree.
 void addInstanceTree(HepRepTreeID instanceTree)
          Adds a related instance tree to this instancetree.
 HepRepInstanceTree copy(HepRepTypeTree typeTree)
          Returns a deep copy of this instancetree.
 HepRepInstanceTree copy(HepRepTypeTree typeTree, HepRepSelectFilter filter)
          Returns a deep copy of this instancetree.
 List getInstances()
          Returns a collection of instances.
 List getInstanceTreeList()
          Returns a collection of associated instance trees.
 Set getInstanceTrees()
          Deprecated. use getInstanveTreeList()
 HepRepTreeID getTypeTree()
          Returns the associated typetree.
 void overlay(HepRepInstanceTree instanceTree)
          Overlays the instance tree on the current tree.
 void removeInstance(HepRepInstance instance)
          Removes an instance from this instancetree.
 
Methods inherited from interface hep.graphics.heprep.HepRepTreeID
getName, getQualifier, getVersion, setQualifier
 

Method Detail

overlay

void overlay(HepRepInstanceTree instanceTree)
Overlays the instance tree on the current tree. The list of instances of the instanceTree has to be the same as the current tree.

Parameters:
instanceTree - tree to overlay

addInstance

void addInstance(HepRepInstance instance)
Adds an instance to this instancetree.

Parameters:
instance - to be added.

removeInstance

void removeInstance(HepRepInstance instance)
Removes an instance from this instancetree.

Parameters:
instance - to be removed.

getInstances

List getInstances()
Returns a collection of instances.

Returns:
collection of HepRepInstances.

addInstanceTree

void addInstanceTree(HepRepTreeID instanceTree)
Adds a related instance tree to this instancetree.

Parameters:
instanceTree - related instancetree.

getInstanceTrees

Set getInstanceTrees()
Deprecated. use getInstanveTreeList()

Returns a collection of associated instance trees.

Returns:
collection of HepRepTreeIDs.

getInstanceTreeList

List getInstanceTreeList()
Returns a collection of associated instance trees.

Returns:
collection of HepRepTreeIDs.

getTypeTree

HepRepTreeID getTypeTree()
Returns the associated typetree.

Returns:
TreeID of the associated typetree.

copy

HepRepInstanceTree copy(HepRepTypeTree typeTree)
                        throws CloneNotSupportedException
Returns a deep copy of this instancetree.

Parameters:
typeTree - associated type tree.
Returns:
copy of this instancetree.
Throws:
CloneNotSupportedException - if copying is not possible.

copy

HepRepInstanceTree copy(HepRepTypeTree typeTree,
                        HepRepSelectFilter filter)
                        throws CloneNotSupportedException
Returns a deep copy of this instancetree.

Parameters:
typeTree - associated type tree.
filter - to filter the instances.
Returns:
copy of this instancetree.
Throws:
CloneNotSupportedException - if copying is not possible.


Copyright 2000-2007 FreeHEP. All Rights Reserved.