com.simplifiedlogic.nitro.util

Class MaterialLooper

java.lang.Object

com.simplifiedlogic.nitro.util.LooperBase

com.simplifiedlogic.nitro.util.MaterialLooper

public abstract class MaterialLooper
extends LooperBase

This is an abstract class which loops over materials on a part, filters the results by various filters, and calls an action method for each material which matches the filters.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	currentName The name of the current material in the loop

Fields inherited from class com.simplifiedlogic.nitro.util.LooperBase

debugKey, isNameEntryPattern, isNamePattern, nameList, namePattern

Constructor Summary

Constructors

Constructor and Description
MaterialLooper()

Method Summary

Methods

Modifier and Type	Method and Description
void	loop(CallPart part) Loop through materials on a Part
abstract void	loopAction(CallMaterial matl) Abstract function which is called for each material which matches the filters.
protected void	processObjectByName(java.lang.String name) Abstract function which is called for each object whose name matches the filters.

Methods inherited from class com.simplifiedlogic.nitro.util.LooperBase

checkName, checkName, checkNameAgainstList, checkNameAgainstList, getDebugKey, getIsNamePattern, getNameList, getNamePattern, setDebugKey, setIsNamePattern, setNameList, setNameList, setNamePattern

Methods inherited from class java.lang.Object

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

Field Detail

currentName

protected java.lang.String currentName

The name of the current material in the loop

Constructor Detail

MaterialLooper

public MaterialLooper()

Method Detail

loop

public void loop(CallPart part)
          throws JLIException,
                 com.ptc.cipjava.jxthrowable

Loop through materials on a Part

Parameters:

part - The part which owns the materials

Throws:

JLIException

com.ptc.cipjava.jxthrowable

loopAction

public abstract void loopAction(CallMaterial matl)
                         throws JLIException,
                                com.ptc.cipjava.jxthrowable

Abstract function which is called for each material which matches the filters. This must be implemented by a class extending this looper class.

Parameters:

matl - The material which matched the filters

Throws:

JLIException

com.ptc.cipjava.jxthrowable

processObjectByName

protected void processObjectByName(java.lang.String name)
                            throws JLIException,
                                   com.ptc.cipjava.jxthrowable

Description copied from class: LooperBase

Abstract function which is called for each object whose name matches the filters. This must be implemented by a class extending this looper class, though many implementers use a dummy method. May be used to force a call to loopAction for a specific name.

Specified by:

processObjectByName in class LooperBase

Parameters:

name - The name of the object that matched the filters

Throws:

JLIException

com.ptc.cipjava.jxthrowable