The model parameter is a reference to the OrcaFlex model.The function signatures for these progress handlers are:ĭef DynamicsProgress(model, time, start, stop) The batchProgressHandler is called when running a batch script (see BatchScriptProgressHandlerProc and ProcessBatchScript). The staticsProgressHandler is called during CalculateStatics() and InvokeLineSetupWizard() (see StaticsProgressHandlerProc), the dynamicsProgressHandler is called while the simulation is running (see DynamicsProgressHandlerProc) and progressHandler is called during TOrcFxAPIHandle running operations (such as Load and Save operations, see C_SetProgressHandler). Progress handler callback functions can be assigned with these attributes. staticsProgressHandler, dynamicsProgressHandler, progressHandler, batchProgressHandler This property returns the first child in the model's group structure. See C_GetModelThreadCount and C_SetModelThreadCount. The threadCount property gets and sets the number of processing threads the model can use. This method returns True if the optional module identified the module parameter is enabled. isTimeDomainDynamicsĪ boolean property that indicates whether the model uses time domain dynamics. isFrequencyDomainDynamicsĪ boolean property that indicates whether the model uses frequency domain dynamics.
ORCAFLEX PYTHON DYNAMICSPROGRESS FULL
restartParentFileNamesĪ property returning the full chain of parent file names for a restart analysis model. outputBrowserGroupStructureWhenTrackingChangesĪ boolean property that determines whether or not the group structure is output when saving text data files for ModelType.Variation or ModelType.Restart model types. In order to create new variation models or restart analysis models, use NewVariationModel() or NewRestartAnalysis(). It is possible to set this property to ModelType.Standard, but attempts to assign a value of ModelType.Variation or ModelType.Restart are not allowed. The model type, one of the following: ModelType.Standard, ModelType.Variation or ModelType.Restart. This is sometimes necessary when loading memory files in order to provide a root for relative paths. The name of file that was most recently loaded or saved. This property is available for both dongle and FlexNet licences. licenceStatusĪ string detailing how the OrcaFlex licence is provided. These properties are not available for FlexNet licences. Properties that give details of the dongle used to provide the OrcaFlex licence. dongleName, dongleAccessMode, donglePort, dongleServer, licenceFileLocation Identifies the current state of the OrcaFlex model returned by C_GetModelState. This property returns true if the simulation has completed. This property returns the simulation stop time. This property returns the simulation start time.
Individual objects can be accessed directly by treating the model itself as the dictionary, for example, the call obj = m will return an OrcaFlexObject instance of the object called 'MyObjectName'. This property returns a tuple of all the objects in the OrcaFlex model. This property returns a ViewParameters object with the attributes set to default values. Attributes and methods defaultViewParameters When the Python garbage collector destroys this object, and it has ownership of the Python objects it contains, then C_DestroyModel is called. If both filename and handle are omitted, or are None, then an empty model is created. The handle is used internally, and by external functions, and is not intended for general use. If the optional handle parameter is specified (from another Model instance) the new model instance will refer to the same underlying OrcaFlex model. The optional threadCount parameter specifies the number of processing threads used for simulations, if omitted then the default is the number of processing cores of the computer. If the optional filename parameter is specified then the constructor attempts to open this as a simulation file first and as a data file second. The constructor creates a new OrcaFlex model object. Model(filename=None, threadCount=None, handle=None)