FreeHEP API
Version v1.2

hep.graphics.heprep
Interface HepRepType

All Superinterfaces:
HepRepAttribute, HepRepConstants, HepRepDefinition
All Known Implementing Classes:
DefaultHepRepType, HepRepTypeAdapter, HepRepTypeAdapter, StreamerHepRepType

public interface HepRepType
extends HepRepDefinition

HepRepType interface.

Author:
Mark Donszelmann

Field Summary
 
Fields inherited from interface hep.graphics.heprep.HepRepConstants
SHOW_DESC, SHOW_EXTRA, SHOW_NAME, SHOW_NONE, SHOW_VALUE, TYPE_BOOLEAN, TYPE_COLOR, TYPE_DOUBLE, TYPE_INT, TYPE_LONG, TYPE_STRING, TYPE_UNKNOWN
 
Method Summary
 void addType(HepRepType type)
          Adds a sub-type to this type.
 HepRepType copy(HepRep heprep, HepRepType parent)
          Returns a deep copy of this type.
 String getDescription()
          Returns the description of this type.
 String getInfoURL()
          Returns the information URL of this type.
 String getName()
          Returns the name of this type.
 HepRepType getSuperType()
          Returns the parent of this type.
 Collection getTypes()
          Returns a collection of all the sub-types of this type.
 
Methods inherited from interface hep.graphics.heprep.HepRepDefinition
addAttDef, addAttDef, getAttDef, getAttDefFromNode, getAttDefsFromNode
 
Methods inherited from interface hep.graphics.heprep.HepRepAttribute
addAttValue, addAttValue, addAttValue, addAttValue, addAttValue, addAttValue, addAttValue, addAttValue, addAttValue, addAttValue, addAttValue, getAttValue, getAttValueFromNode, getAttValuesFromNode, removeAttValue
 

Method Detail

addType

public void addType(HepRepType type)
             throws IOException
Adds a sub-type to this type.

Parameters:
type - sub-type to be added.
Throws:
IOException - only if written directly to a stream.

getName

public String getName()
Returns the name of this type.

Returns:
name of type.

getDescription

public String getDescription()
Returns the description of this type.

Returns:
description of type.

getInfoURL

public String getInfoURL()
Returns the information URL of this type.

Returns:
info URL of type.

getSuperType

public HepRepType getSuperType()
Returns the parent of this type.

Returns:
parent of type, or null if top-level.

getTypes

public Collection getTypes()
Returns a collection of all the sub-types of this type.

Returns:
collection of HepRepTypes.

copy

public HepRepType copy(HepRep heprep,
                       HepRepType parent)
                throws CloneNotSupportedException
Returns a deep copy of this type.

Parameters:
heprep - top-level heprep. (Not sure if this is necessary).
parent - to which this copy is added.
Returns:
copy of this type.
Throws:
CloneNotSupportedException - if copying is not possible.

FreeHEP API
Version v1.2

Copyright © 2000-2003 FreeHEP, All Rights Reserved.