OrsMacroPlayer

Controller of a macro recording and execution

author:ORS Team contact:http://theobjects.com email:info@theobjects.com organization:Object Research Systems (ORS), Inc. address:460 Ste-Catherine Ouest, suite 600, Montréal, Québec, Canada, H3B 1A7 copyright:Object Research Systems (ORS), Inc. All rights reserved 2021. date:Oct 20 2016 09:50 dragonflyVersion:  3.0 UUID:9ee31aae761511e7b35d448a5b5d70c0

Class Code

class OrsPythonPlugins.OrsMacroPlayer.OrsMacroPlayer.OrsMacroPlayer(varname=None)

classmethod OrsMacroPlayer_openGUI()

UIDescriptors = [<ORSServiceClass.OrsPlugin.uidescriptor.UIDescriptor object>]

classmethod appendTestToExistingFile(existingTestPath)

applyModificationToDeclaredVariableOfSelection(declaredVariable, newState, newVariableValue=None)

canContinueRecording()

canDeleteBlock(blockIndex)

canPauseRecording()

canRefreshFile()

canSetDeclaredVariablesOfSelection()

canStartRecording()

canStopRecording()

cleanup()

Deletes the variables managed by the plugin. It is the place to remove callbacks and other references to Python objects that would prevent them to be garbage collected. This method is called during the process of deletion of the plugin. It calls for the cleanup and deletion of the forms.

clearMacro()

classmethod contextualMenuStartMacrosFromSelection(listSelectedObjectsRepr)

classmethod contextualMenuStartMacrosFromSelection_menuItemDefinition()

continueRecording()

classmethod defaultMacroTestPath()

defineVariables(dictVariables)

defineVariablesFromSelection(listSelectedObjects)

deleteBlock(blockIndex)

deleteMacro(fullname)

executeMacro(runFullMacro=True, automaticSelectionSingleElement=False)

classmethod generateAndAppendTestFile(macroPath, existingTestPath)

classmethod generateMacroTestFile(macroPath, testPath)

getAssignationStateOfDeclaredVariableOfSelection(declaredVariable)

getAssignedValueToDeclaredVariableOfSelection(declaredVariable)

getBlockCount()

getBlockIndexInExecution()

getCurrentMacroBibliographyModel()

getDeclaredInputVariableDescriptorsOfSelection()

getDeclaredVariablesAssignedBeforeBlockOfSelection()

getIsAssignmentToDeclaredVariableModifiedOfSelection(declaredVariable)

getIsMacroPlayingInExecution()

getIsMacroRecordingInExecution()

getIsMutedOfSelection()

getLastError()

getLastErrorOfSelection()

classmethod getMainFormClass()

Gets the class of the main form

Returns:output –

getOriginalMacroBibliographyModel()

getTreeBlocksModel()

getVariablesToDefine()

interruptMacroWhileRunning(interruptAsStop=True)

isRecordingPaused()

isThereAnError()

isThereAnErrorOfSelection()

keepAlive = False

multiple = False

classmethod openWithSpecificMacro(macroPath)

Method called to start an instance of the current plugin and show a specific macro.

Parameters:macroPath – path of the macro to show

pauseRecording()

refreshFile()

revertModificationToDeclaredVariableOfSelection(declaredVariable)

savable = False

saveAsNewMacro(macroPath, macroName)

saveMacroAs(fullname)

setCallbackMethodToUpdateCurrentBlockInExecution(aMethod)

setCallbackMethodToUpdateDefinedVariablesWidgets(aMethod)

setMacroFromPath(macroPath)

shouldLastErrorBeGivenToTheUser()

showInToolbar = True

classmethod startMacroOnSelection(macroPath, listSelectedObjectsGUID)

Method called from the contextual menu item to start an instance of the current plugin and start the execution of a specific macro with variables set from the selection. The UI will be shown only if a user interaction is required.

Parameters:

• macroPath – path of the macro to execute
• listSelectedObjectsGUID – string representation of the selected objects

startRecording(macroFullFilename, writeBlockStartEndTime)

stopPlaying()

stopRecording()

classmethod toolsMenu()

updateMacroCache(macroPaths=None)