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 MATLAB INTERFACE 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 ofx.mtVariation or ofx.mtRestart 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 ofx.mtStandard, but attempts to assign a value of ofx.mtVariation or ofx.mtRestart are not allowed. The model type, one of the following: ofx.mtStandard, ofx.mtVariation or ofx.mtRestart. 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 The value returned will be one of: ofx.msReset, ofx.msCalculatingStatics, ofx.msInStaticState, ofx.msSimulationStopped, ofx.msSimulationStoppedUnstable. This function returns the current state of the OrcaFlex model, see the C API documentation for C_GetModelState. This property returns true if the simulation has completed. This function returns the simulation stop time. This function returns the simulation start time. This function returns a cell array of ofxObject instances for each of the OrcaFlex model objects in the model. These provide convenient alternatives to the RelativeToObjectHandle and DisturbanceVesselHandle attributes by allowing OrcaFlex objects to be used instead of their handles. There are two additional attributes, RelativeToObject and DisturbanceVessel, in the MATLAB API ViewParameters class. This structure is used as a parameter to the SaveModelView and SaveModelViewMem functions. This function returns a structure representing the C API structure TViewParameters. Properties and functions defaultViewParameters When the MATLAB garbage collector destroys this object, and it has ownership of the MATLAB objects it contains, then the C_DestroyModel C API function is called. Otherwise the default number of processing threads is the number of processing cores on the computer. When this parameter is specified the C API function C_CreateModel2 is called. The optional paramater createModelParams is a structure to specify the number of processing threads required for a simulation, see CreateModelParams. See the C API documentation C_CreateModel. If no parameters are given then an empty model is created. If a modelHandle parameter is specified (from another ofxModel instance) the new ofxModel instance will be a copy of the original ofxModel instance but without ownership of the MATLAB Interface objects. If the 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.