com.simplifiedlogic.nitro.util

Class ModelLooper

java.lang.Object

com.simplifiedlogic.nitro.util.LooperBase

com.simplifiedlogic.nitro.util.ModelLooper

Direct Known Subclasses:

JLFamilyTable.DeleteLooper, JLNote.CopyLooper, JLNote.SetLooper, JLParameter.CopyLooper, JLParameter.DeleteLooper, JLParameter.ListLooper, JLParameter.SetBatchLooper, JLParameter.SetDesignateLooper, JLParameter.SetLooper

public abstract class ModelLooper
extends LooperBase

This is an abstract class which loops over models that are either a) in memory or b) in a drawing, filters the results by various filters, and calls an action method for each model which matches the filters.

Field Summary

Fields

Modifier and Type	Field and Description
boolean	singleOp Output flag indicating that only a single model was specified in the name filter

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

currentName, debugKey, isNameEntryPattern, isNamePattern, nameList, namePattern

Constructor Summary

Constructors

Constructor and Description
ModelLooper()

Method Summary

Methods

Modifier and Type	Method and Description
CallModel2D	getDrawing()
CallSession	getSession()
boolean	isDefaultToActive()
void	loop()
abstract boolean	loopAction(CallModel m) Abstract function which is called for each model which matches the filters.
protected void	processObjectByName(java.lang.String name) Abstract function which is called for each object whose name matches the filters.
void	setDefaultToActive(boolean defaultToActive)
void	setDrawing(CallModel2D drawing)
void	setSession(CallSession session)

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

singleOp

public boolean singleOp

Output flag indicating that only a single model was specified in the name filter

Constructor Detail

ModelLooper

public ModelLooper()

Method Detail

loop

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

Throws:

JLIException

com.ptc.cipjava.jxthrowable

loopAction

public abstract boolean loopAction(CallModel m)
                            throws JLIException,
                                   com.ptc.cipjava.jxthrowable

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

Parameters:

m - The model which matched the filters

Returns:

True to abort the loop, false to continue it

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

isDefaultToActive

public boolean isDefaultToActive()

Returns:

Whether to just loop on the active model if no filters are given

setDefaultToActive

public void setDefaultToActive(boolean defaultToActive)

Parameters:

defaultToActive - Whether to just loop on the active model if no filters are given

getSession

public CallSession getSession()

Returns:

The Creo session

setSession

public void setSession(CallSession session)

Parameters:

session - The Creo session

getDrawing

public CallModel2D getDrawing()

Returns:

The drawing containing the models, if specified

setDrawing

public void setDrawing(CallModel2D drawing)

Parameters:

drawing - The drawing containing the models, if specified