Public Member Functions
def addBase (self, obj, base, sub)

def addBaseProperty (self, obj)

def addOpValues (self, obj, values)

def applyExpression (self, obj, prop, expr)

def execute (self, obj)

def getCycleTimeEstimate (self, obj)

def getJob (self, obj)

def initOperation (self, obj)

def onChanged (self, obj, prop)

def onDocumentRestored (self, obj)

def opExecute (self, obj)

def opFeatures (self, obj)

def opOnChanged (self, obj, prop)

def opOnDocumentRestored (self, obj)

def opRejectAddBase (self, obj, base, sub)

def opSetDefaultValues (self, obj, job)

def opUpdateDepths (self, obj)

def setDefaultValues (self, obj)

def setEditorModes (self, obj, features)

def updateDepths (self, obj, ignoreErrors=False)

Public Attributes
addNewProps

commandlist

horizFeed

horizRapid

job

model

radius

stock

tool

vertFeed

vertRapid

Detailed Description

Base class for proxy objects of all Path operations.

Use this class as a base class for new operations. It provides properties
and some functionality for the standard properties each operation supports.
By OR'ing features from the feature list an operation can select which ones
of the standard features it requires and/or supports.

The currently supported features are:
    FeatureTool          ... Use of a ToolController
    FeatureDepths        ... Depths, for start, final
    FeatureHeights       ... Heights, safe and clearance
    FeatureStartPoint    ... Supports setting a start point
    FeatureFinishDepth   ... Operation supports a finish depth
    FeatureStepDown      ... Support for step down
    FeatureNoFinalDepth  ... Disable support for final depth modifications
    FeatureBaseVertexes  ... Base geometry support for vertexes
    FeatureBaseEdges     ... Base geometry support for edges
    FeatureBaseFaces     ... Base geometry support for faces
    FeatureBasePanels    ... Base geometry support for Arch.Panels
    FeatureLocations     ... Base location support
    FeatureCoolant       ... Support for operation coolant

The base class handles all base API and forwards calls to subclasses with
an op prefix. For instance, an op is not expected to overwrite onChanged(),
but implement the function opOnChanged().
If a base class overwrites a base API function it should call the super's
implementation - otherwise the base functionality might be broken.

Member Function Documentation

◆ addBase()

def PathScripts.PathOp.ObjectOp.addBase	(	self,
		obj,
		base,
		sub
	)

References PathScripts.PathOp.ObjectOp._setBaseAndStock(), PathScripts.PathOp.ObjectOp.job, PathScripts.PathJobDlg.JobTemplateExport.job, PathScripts.PathDeburr.ObjectDeburr.opRejectAddBase(), and PathScripts.PathOp.ObjectOp.opRejectAddBase().

Referenced by PathScripts.PathOpGui.TaskPanelBaseGeometryPage.importBaseGeometry(), PathScripts.PathCircularHoleBaseGui.TaskPanelHoleGeometryPage.registerSignalHandlers(), and PathScripts.PathOpGui.TaskPanelBaseGeometryPage.registerSignalHandlers().

◆ addBaseProperty()

def PathScripts.PathOp.ObjectOp.addBaseProperty	(	self,
		obj
	)

Referenced by PathScripts.PathOp.ObjectOp.addOpValues(), and PathScripts.PathOp.ObjectOp.onDocumentRestored().

◆ addOpValues()

def PathScripts.PathOp.ObjectOp.addOpValues	(	self,
		obj,
		values
	)

References PathScripts.PathOp.ObjectOp.addBaseProperty(), PathScripts.PathOp.ObjectOp.addOpValues(), PathScripts.PathEngrave.ObjectEngrave.opFeatures(), PathScripts.PathAreaOp.ObjectOp.opFeatures(), PathScripts.PathDeburr.ObjectDeburr.opFeatures(), PathScripts.PathCircularHoleBase.ObjectOp.opFeatures(), PathScripts.PathOp.ObjectOp.opFeatures(), and PathScripts.PathAdaptive.PathAdaptive.opFeatures().

Referenced by PathScripts.PathOp.ObjectOp.addOpValues(), and PathScripts.PathOp.ObjectOp.onDocumentRestored().

◆ applyExpression()

def PathScripts.PathOp.ObjectOp.applyExpression	(	self,
		obj,
		prop,
		expr
	)

applyExpression(obj, prop, expr) ... set expression expr on obj.prop if expr is set

Referenced by PathScripts.PathDrilling.ObjectDrilling.opSetDefaultValues(), and PathScripts.PathOp.ObjectOp.setDefaultValues().

◆ execute()

def PathScripts.PathOp.ObjectOp.execute	(	self,
		obj
	)

execute(obj) ... base implementation - do not overwrite! Verifies that the operation is assigned to a job and that the job also has a valid Base. It also sets the following instance variables that can and should be safely be used by implementation of opExecute(): self.model ... List of base objects of the Job itself self.stock ... Stock object for the Job itself self.vertFeed ... vertical feed rate of assigned tool self.vertRapid ... vertical rapid rate of assigned tool self.horizFeed ... horizontal feed rate of assigned tool self.horizRapid ... norizontal rapid rate of assigned tool self.tool ... the actual tool being used self.radius ... the main radius of the tool being used self.commandlist ... a list for collecting all commands produced by the operation Once everything is validated and above variables are set the implementation calls opExecute(obj) - which is expected to add the generated commands to self.commandlist Finally the base implementation adds a rapid move to clearance height and assigns the receiver's Path property from the command list.

Referenced by ArchSite.Compass.buildCoordinates(), ArchSchedule.CommandArchSchedule.IsActive(), PathScripts.PathStock.StockFromBase.onChanged(), PathScripts.PathStock.StockCreateBox.onChanged(), PathScripts.PathStock.StockCreateCylinder.onChanged(), and FeaturePython.DistanceBolt.onChanged().

◆ getCycleTimeEstimate()

def PathScripts.PathOp.ObjectOp.getCycleTimeEstimate	(	self,
		obj
	)

Referenced by PathScripts.PathOp.ObjectOp.execute().

◆ getJob()

def PathScripts.PathOp.ObjectOp.getJob	(	self,
		obj
	)

getJob(obj) ... return the job this operation is part of.

References PathScripts.PathOp.ObjectOp._setBaseAndStock(), PathScripts.PathOp.ObjectOp.job, and PathScripts.PathJobDlg.JobTemplateExport.job.

Referenced by PathScripts.PathCircularHoleBase.ObjectOp.findAllHoles().

◆ initOperation()

def PathScripts.PathOp.ObjectOp.initOperation	(	self,
		obj
	)

initOperation(obj) ... implement to create additional properties. Should be overwritten by subclasses.

Reimplemented in PathScripts.PathAdaptive.PathAdaptive, PathScripts.PathCircularHoleBase.ObjectOp, PathScripts.PathSurface.ObjectSurface, PathScripts.PathAreaOp.ObjectOp, PathScripts.PathWaterline.ObjectWaterline, PathScripts.PathDeburr.ObjectDeburr, PathScripts.PathEngrave.ObjectEngrave, and PathScripts.PathProbe.ObjectProbing.

◆ onChanged()

def PathScripts.PathOp.ObjectOp.onChanged	(	self,
		obj,
		prop
	)

onChanged(obj, prop) ... base implementation of the FC notification framework. Do not overwrite, overwrite opOnChanged() instead.

Reimplemented in PathScripts.PathSurface.ObjectSurface, and PathScripts.PathWaterline.ObjectWaterline.

References PathScripts.PathAreaOp.ObjectOp.opOnChanged(), PathScripts.PathOp.ObjectOp.opOnChanged(), and PathScripts.PathOp.ObjectOp.updateDepths().

Referenced by ArchSite.Compass.buildCoordinates(), and ArchAxis.CommandArchGrid.IsActive().

◆ onDocumentRestored()

def PathScripts.PathOp.ObjectOp.onDocumentRestored	(	self,
		obj
	)

◆ opExecute()

def PathScripts.PathOp.ObjectOp.opExecute	(	self,
		obj
	)

opExecute(obj) ... called whenever the receiver needs to be recalculated. See documentation of execute() for a list of base functionality provided. Should be overwritten by subclasses.

Reimplemented in PathScripts.PathAdaptive.PathAdaptive, PathScripts.PathSurface.ObjectSurface, PathScripts.PathWaterline.ObjectWaterline, PathScripts.PathCircularHoleBase.ObjectOp, PathScripts.PathDeburr.ObjectDeburr, PathScripts.PathEngrave.ObjectEngrave, and PathScripts.PathProbe.ObjectProbing.

Referenced by PathScripts.PathOp.ObjectOp.execute().

◆ opFeatures()

def PathScripts.PathOp.ObjectOp.opFeatures	(	self,
		obj
	)

opFeatures(obj) ... returns the OR'ed list of features used and supported by the operation. The default implementation returns "FeatureTool | FeatureDeptsh | FeatureHeights | FeatureStartPoint" Should be overwritten by subclasses.

Reimplemented in PathScripts.PathAdaptive.PathAdaptive, PathScripts.PathCircularHoleBase.ObjectOp, PathScripts.PathSurface.ObjectSurface, PathScripts.PathWaterline.ObjectWaterline, PathScripts.PathDeburr.ObjectDeburr, PathScripts.PathAreaOp.ObjectOp, PathScripts.PathEngrave.ObjectEngrave, and PathScripts.PathProbe.ObjectProbing.

Referenced by PathScripts.PathOp.ObjectOp.addOpValues(), PathScripts.PathOp.ObjectOp.execute(), PathScripts.PathOp.ObjectOp.onDocumentRestored(), PathScripts.PathEngraveBase.ObjectOp.opSetDefaultValues(), PathScripts.PathOp.ObjectOp.setDefaultValues(), and PathScripts.PathOp.ObjectOp.updateDepths().

◆ opOnChanged()

def PathScripts.PathOp.ObjectOp.opOnChanged	(	self,
		obj,
		prop
	)

opOnChanged(obj, prop) ... overwrite to process property changes. This is a callback function that is invoked each time a property of the receiver is assigned a value. Note that the FC framework does not distinguish between assigning a different value and assigning the same value again. Can safely be overwritten by subclasses.

Reimplemented in PathScripts.PathAreaOp.ObjectOp.

Referenced by PathScripts.PathOp.ObjectOp.onChanged().

◆ opOnDocumentRestored()

def PathScripts.PathOp.ObjectOp.opOnDocumentRestored	(	self,
		obj
	)

opOnDocumentRestored(obj) ... implement if an op needs special handling like migrating the data model. Should be overwritten by subclasses.

Reimplemented in PathScripts.PathSurface.ObjectSurface, PathScripts.PathWaterline.ObjectWaterline, PathScripts.PathAreaOp.ObjectOp, PathScripts.PathDeburr.ObjectDeburr, PathScripts.PathEngrave.ObjectEngrave, PathScripts.PathHelix.ObjectHelix, and PathScripts.PathPocket.ObjectPocket.

Referenced by PathScripts.PathOp.ObjectOp.onDocumentRestored().

◆ opRejectAddBase()

def PathScripts.PathOp.ObjectOp.opRejectAddBase	(	self,
		obj,
		base,
		sub
	)

opRejectAddBase(base, sub) ... if op returns True the addition of the feature is prevented. Should be overwritten by subclasses.

Reimplemented in PathScripts.PathDeburr.ObjectDeburr.

Referenced by PathScripts.PathOp.ObjectOp.addBase().

◆ opSetDefaultValues()

def PathScripts.PathOp.ObjectOp.opSetDefaultValues	(	self,
		obj,
		job
	)

opSetDefaultValues(obj, job) ... overwrite to set initial default values. Called after the receiver has been fully created with all properties. Can safely be overwritten by subclasses.

Reimplemented in PathScripts.PathAdaptive.PathAdaptive, PathScripts.PathSurface.ObjectSurface, PathScripts.PathWaterline.ObjectWaterline, PathScripts.PathHelix.ObjectHelix, PathScripts.PathDrilling.ObjectDrilling, PathScripts.PathAreaOp.ObjectOp, PathScripts.PathDeburr.ObjectDeburr, PathScripts.PathEngraveBase.ObjectOp, and PathScripts.PathProbe.ObjectProbing.

Referenced by PathScripts.PathOp.ObjectOp.setDefaultValues().