Python scripting - Common operators

CENPyOlpProgramProcessGeometryOperator

 

The object of the CENPyOlpProgramProcessGeometryOperator class is passed to the ProgramProcessGeometries callbacks as a parameter.

It can be used to obtain the required operators within the scope of the ProgramProcessGeometries callback in the Auxiliary commands script files.

 

[Example]

def ProgramProcessGeometries(operator: CENPyOlpProgramProcessGeometryOperator):

   pass

 

Methods

 

GetLoggerOperator(): CENPyOlpLogOperator

 

o

return

Object of CENPyOlpLogOperator class

 

This operator gives the possibility to log issues resulting by user input.

 

[Example]

   logOperator = operator.GetLoggerOperator()

 


 

GetCsvParserOperator(): CENPyOlpCsvParserOperator

 

o

return

Object of CENPyOlpCsvParserOperator class

 

This operator gives the possibility to work with CSV files. Please check the CENPyOlpCsvParserOperator class to see all available functions.

 

[Example]

   csvParser = operator.GetCsvParserOperator() 

 


 

GetController(): CENPyOlpController

 

o

return

Object of CENPyOlpController class

 

This method returns the parent controller.

 

[Example]

   controller = operator.GetController()

 


 

GetActiveProgram(): CENPyOlpProgram

 

o

return

Object of CENPyOlpProgram class

 

Returns the active program of the controller, nullptr, if there is no program.

 

[Example]

   activeProgram = operator.GetActiveProgram()

 


 

GetSelectedProcessGeometries(ProcGeoType: geoTypeFilter): list

 

o

geoTypeFilter

Type of process geometry to return. Returns all PGs if type is PROCGEO_NONE

 

o

return

list sequence of CENPyOlpProcessGeometryOperator objects

 

Get a list of all selected process geometries.

 

[Example]  

   processGeometries = operator.GetSelectedProcessGeometries() 

 


 

GetStartStateNames(): list

 

o

return

list of existing start state names

 

Get a list of all start state names from the current project.

 

[Example]  

   startStateNames = operator.GetStartStateNames() 

 


 

 


Previous
Previous page
Chapter
Chapter page
Next
Next page